Inherits from PFObject : NSObject
Conforms to PFSubclassing
Declared in PFUser.h

Overview

A Parse Framework User Object that is a local representation of a user persisted to the Parse cloud. This class
is a subclass of a PFObject, and retains the same functionality of a PFObject, but also extends it with various
user specific methods, like authentication, signing up, and validation uniqueness.

Many APIs responsible for linking a PFUser with Facebook or Twitter have been deprecated in favor of dedicated
utilities for each social network. See PFFacebookUtils and PFTwitterUtils for more information.

Tasks

Other Methods

Accessing the Current User

  • + currentUser

    Gets the currently logged in user from disk and returns an instance of it.
  •   sessionToken

    The session token for the PFUser. This is set by the server upon successful authentication.

         property
  •   isNew

    Whether the PFUser was just created from a request. This is only set after a Facebook or Twitter login.

         property
  • – isAuthenticated

    Whether the user is an authenticated object for the device. An authenticated PFUser is one that is obtained via
    a signUp or logIn method. An authenticated object is required in order to save (with altered values) or delete it.

Creating a New User

Logging in

  • + logInWithUsername:password:

    Makes a request to login a user with specified credentials. Returns an instance
    of the successfully logged in PFUser. This will also cache the user locally so
    that calls to userFromCurrentUser will use the latest logged in user.
  • + logInWithUsername:password:error:

    Makes a request to login a user with specified credentials. Returns an
    instance of the successfully logged in PFUser. This will also cache the user
    locally so that calls to userFromCurrentUser will use the latest logged in user.
  • + logInWithUsernameInBackground:password:

    Makes an asynchronous request to login a user with specified credentials.
    Returns an instance of the successfully logged in PFUser. This will also cache
    the user locally so that calls to userFromCurrentUser will use the latest logged in user.
  • + logInWithUsernameInBackground:password:target:selector:

    Makes an asynchronous request to login a user with specified credentials.
    Returns an instance of the successfully logged in PFUser. This will also cache
    the user locally so that calls to userFromCurrentUser will use the latest logged in user.
    The selector for the callback should look like: myCallback:(PFUser *)user error:(NSError **)error
  • + logInWithUsernameInBackground:password:block:

    Makes an asynchronous request to log in a user with specified credentials.
    Returns an instance of the successfully logged in PFUser. This will also cache
    the user locally so that calls to userFromCurrentUser will use the latest logged in user.

Logging Out

Requesting a Password Reset

Querying for Users

  • + query

    Creates a query for PFUser objects.

Properties

email

The email for the PFUser.

@property (nonatomic, retain) NSString *email

Discussion

The email for the PFUser.

Declared In

PFUser.h

isNew

Whether the PFUser was just created from a request. This is only set after a Facebook or Twitter login.

@property (readonly, assign) BOOL isNew

Discussion

Whether the PFUser was just created from a request. This is only set after a Facebook or Twitter login.

Declared In

PFUser.h

password

The password for the PFUser. This will not be filled in from the server with
the password. It is only meant to be set.

@property (nonatomic, retain) NSString *password

Discussion

The password for the PFUser. This will not be filled in from the server with
the password. It is only meant to be set.

Declared In

PFUser.h

sessionToken

The session token for the PFUser. This is set by the server upon successful authentication.

@property (nonatomic, retain) NSString *sessionToken

Discussion

The session token for the PFUser. This is set by the server upon successful authentication.

Declared In

PFUser.h

username

The username for the PFUser.

@property (nonatomic, retain) NSString *username

Discussion

The username for the PFUser.

Declared In

PFUser.h

Class Methods

currentUser

Gets the currently logged in user from disk and returns an instance of it.

+ (PFUser *)currentUser

Return Value

Returns a PFUser that is the currently logged in user. If there is none, returns nil.

Discussion

Gets the currently logged in user from disk and returns an instance of it.

Declared In

PFUser.h

enableAutomaticUser

Enables automatic creation of anonymous users. After calling this method, [PFUser currentUser] will always have a value.
The user will only be created on the server once the user has been saved, or once an object with a relation to that user or
an ACL that refers to the user has been saved.

+ (void)enableAutomaticUser

Discussion

Enables automatic creation of anonymous users. After calling this method, [PFUser currentUser] will always have a value.
The user will only be created on the server once the user has been saved, or once an object with a relation to that user or
an ACL that refers to the user has been saved.

Note: saveEventually will not work if an item being saved has a relation to an automatic user that has never been saved.

Declared In

PFUser.h

logInWithUsername:password:

Makes a request to login a user with specified credentials. Returns an instance
of the successfully logged in PFUser. This will also cache the user locally so
that calls to userFromCurrentUser will use the latest logged in user.

+ (PFUser *)logInWithUsername:(NSString *)username password:(NSString *)password

Parameters

username

The username of the user.

password

The password of the user.

Return Value

Returns an instance of the PFUser on success. If login failed for either wrong password or wrong username, returns nil.

Discussion

Makes a request to login a user with specified credentials. Returns an instance
of the successfully logged in PFUser. This will also cache the user locally so
that calls to userFromCurrentUser will use the latest logged in user.

Declared In

PFUser.h

logInWithUsername:password:error:

Makes a request to login a user with specified credentials. Returns an
instance of the successfully logged in PFUser. This will also cache the user
locally so that calls to userFromCurrentUser will use the latest logged in user.

+ (PFUser *)logInWithUsername:(NSString *)username password:(NSString *)password error:(NSError **)error

Parameters

username

The username of the user.

password

The password of the user.

error

The error object to set on error.

Return Value

Returns an instance of the PFUser on success. If login failed for either wrong password or wrong username, returns nil.

Discussion

Makes a request to login a user with specified credentials. Returns an
instance of the successfully logged in PFUser. This will also cache the user
locally so that calls to userFromCurrentUser will use the latest logged in user.

Declared In

PFUser.h

logInWithUsernameInBackground:password:

Makes an asynchronous request to login a user with specified credentials.
Returns an instance of the successfully logged in PFUser. This will also cache
the user locally so that calls to userFromCurrentUser will use the latest logged in user.

+ (void)logInWithUsernameInBackground:(NSString *)username password:(NSString *)password

Parameters

username

The username of the user.

password

The password of the user.

Discussion

Makes an asynchronous request to login a user with specified credentials.
Returns an instance of the successfully logged in PFUser. This will also cache
the user locally so that calls to userFromCurrentUser will use the latest logged in user.

Declared In

PFUser.h

logInWithUsernameInBackground:password:block:

Makes an asynchronous request to log in a user with specified credentials.
Returns an instance of the successfully logged in PFUser. This will also cache
the user locally so that calls to userFromCurrentUser will use the latest logged in user.

+ (void)logInWithUsernameInBackground:(NSString *)username password:(NSString *)password block:(PFUserResultBlock)block

Parameters

username

The username of the user.

password

The password of the user.

block

The block to execute. The block should have the following argument signature: (PFUser user, NSError error)

Discussion

Makes an asynchronous request to log in a user with specified credentials.
Returns an instance of the successfully logged in PFUser. This will also cache
the user locally so that calls to userFromCurrentUser will use the latest logged in user.

Declared In

PFUser.h

logInWithUsernameInBackground:password:target:selector:

Makes an asynchronous request to login a user with specified credentials.
Returns an instance of the successfully logged in PFUser. This will also cache
the user locally so that calls to userFromCurrentUser will use the latest logged in user.
The selector for the callback should look like: myCallback:(PFUser *)user error:(NSError **)error

+ (void)logInWithUsernameInBackground:(NSString *)username password:(NSString *)password target:(id)target selector:(SEL)selector

Parameters

username

The username of the user.

password

The password of the user.

target

Target object for the selector.

selector

The selector that will be called when the asynchrounous request is complete.

Discussion

Makes an asynchronous request to login a user with specified credentials.
Returns an instance of the successfully logged in PFUser. This will also cache
the user locally so that calls to userFromCurrentUser will use the latest logged in user.
The selector for the callback should look like: myCallback:(PFUser *)user error:(NSError **)error

Declared In

PFUser.h

logOut

Logs out the currently logged in user on disk.

+ (void)logOut

Discussion

Logs out the currently logged in user on disk.

Declared In

PFUser.h

parseClassName

The name of the PFUser class in the REST API. This is a required
PFSubclassing method

+ (NSString *)parseClassName

Discussion

The name of the PFUser class in the REST API. This is a required
PFSubclassing method

Declared In

PFUser.h

query

Creates a query for PFUser objects.

+ (PFQuery *)query

Discussion

Creates a query for PFUser objects.

Declared In

PFUser.h

requestPasswordResetForEmail:

Send a password reset request for a specified email. If a user account exists with that email,
an email will be sent to that address with instructions on how to reset their password.

+ (BOOL)requestPasswordResetForEmail:(NSString *)email

Parameters

email

Email of the account to send a reset password request.

Return Value

Returns true if the reset email request is successful. False if no account was found for the email address.

Discussion

Send a password reset request for a specified email. If a user account exists with that email,
an email will be sent to that address with instructions on how to reset their password.

Declared In

PFUser.h

requestPasswordResetForEmail:error:

Send a password reset request for a specified email and sets an error object. If a user
account exists with that email, an email will be sent to that address with instructions
on how to reset their password.

+ (BOOL)requestPasswordResetForEmail:(NSString *)email error:(NSError **)error

Parameters

email

Email of the account to send a reset password request.

error

Error object to set on error.

Return Value

Returns true if the reset email request is successful. False if no account was found for the email address.

Discussion

Send a password reset request for a specified email and sets an error object. If a user
account exists with that email, an email will be sent to that address with instructions
on how to reset their password.

Declared In

PFUser.h

requestPasswordResetForEmailInBackground:

Send a password reset request asynchronously for a specified email and sets an
error object. If a user account exists with that email, an email will be sent to
that address with instructions on how to reset their password.

+ (void)requestPasswordResetForEmailInBackground:(NSString *)email

Parameters

email

Email of the account to send a reset password request.

Discussion

Send a password reset request asynchronously for a specified email and sets an
error object. If a user account exists with that email, an email will be sent to
that address with instructions on how to reset their password.

Declared In

PFUser.h

requestPasswordResetForEmailInBackground:block:

Send a password reset request asynchronously for a specified email.
If a user account exists with that email, an email will be sent to that address with instructions
on how to reset their password.

+ (void)requestPasswordResetForEmailInBackground:(NSString *)email block:(PFBooleanResultBlock)block

Parameters

email

Email of the account to send a reset password request.

block

The block to execute. The block should have the following argument signature: (BOOL succeeded, NSError *error)

Discussion

Send a password reset request asynchronously for a specified email.
If a user account exists with that email, an email will be sent to that address with instructions
on how to reset their password.

Declared In

PFUser.h

requestPasswordResetForEmailInBackground:target:selector:

Send a password reset request asynchronously for a specified email and sets an error object.
If a user account exists with that email, an email will be sent to that address with instructions
on how to reset their password.

+ (void)requestPasswordResetForEmailInBackground:(NSString *)email target:(id)target selector:(SEL)selector

Parameters

email

Email of the account to send a reset password request.

target

Target object for the selector.

selector

The selector that will be called when the asynchronous request is complete. It should have the following signature: (void)callbackWithResult:(NSNumber *)result error:(NSError **)error. error will be nil on success and set if there was an error. [result boolValue] will tell you whether the call succeeded or not.

Discussion

Send a password reset request asynchronously for a specified email and sets an error object.
If a user account exists with that email, an email will be sent to that address with instructions
on how to reset their password.

Declared In

PFUser.h

user

Creates a new PFUser object.

+ (PFUser *)user

Return Value

Returns a new PFUser object.

Discussion

Creates a new PFUser object.

Declared In

PFUser.h

Instance Methods

isAuthenticated

Whether the user is an authenticated object for the device. An authenticated PFUser is one that is obtained via
a signUp or logIn method. An authenticated object is required in order to save (with altered values) or delete it.

- (BOOL)isAuthenticated

Return Value

Returns whether the user is authenticated.

Discussion

Whether the user is an authenticated object for the device. An authenticated PFUser is one that is obtained via
a signUp or logIn method. An authenticated object is required in order to save (with altered values) or delete it.

Declared In

PFUser.h

signUp

Signs up the user. Make sure that password and username are set. This will also enforce that the username isn’t already taken.

- (BOOL)signUp

Return Value

Returns true if the sign up was successful.

Discussion

Signs up the user. Make sure that password and username are set. This will also enforce that the username isn’t already taken.

Declared In

PFUser.h

signUp:

Signs up the user. Make sure that password and username are set. This will also enforce that the username isn’t already taken.

- (BOOL)signUp:(NSError **)error

Parameters

error

Error object to set on error.

Return Value

Returns whether the sign up was successful.

Discussion

Signs up the user. Make sure that password and username are set. This will also enforce that the username isn’t already taken.

Declared In

PFUser.h

signUpInBackground

Signs up the user asynchronously. Make sure that password and username are set. This will also enforce that the username isn’t already taken.

- (void)signUpInBackground

Discussion

Signs up the user asynchronously. Make sure that password and username are set. This will also enforce that the username isn’t already taken.

Declared In

PFUser.h

signUpInBackgroundWithBlock:

Signs up the user asynchronously. Make sure that password and username are set. This will also enforce that the username isn’t already taken.

- (void)signUpInBackgroundWithBlock:(PFBooleanResultBlock)block

Parameters

block

The block to execute. The block should have the following argument signature: (BOOL succeeded, NSError *error)

Discussion

Signs up the user asynchronously. Make sure that password and username are set. This will also enforce that the username isn’t already taken.

Declared In

PFUser.h

signUpInBackgroundWithTarget:selector:

Signs up the user asynchronously. Make sure that password and username are set. This will also enforce that the username isn’t already taken.

- (void)signUpInBackgroundWithTarget:(id)target selector:(SEL)selector

Parameters

target

Target object for the selector.

selector

The selector that will be called when the asynchrounous request is complete. It should have the following signature: (void)callbackWithResult:(NSNumber *)result error:(NSError **)error. error will be nil on success and set if there was an error. [result boolValue] will tell you whether the call succeeded or not.

Discussion

Signs up the user asynchronously. Make sure that password and username are set. This will also enforce that the username isn’t already taken.

Declared In

PFUser.h