com.stackmob.sdk.model
Class StackMobUser

java.lang.Object
  com.stackmob.sdk.model.StackMobModel
      com.stackmob.sdk.model.StackMobUser

public abstract class StackMobUser
extends StackMobModel

A specialized subclass of StackMobModel to represent users of your app. Extend this class with the fields you want and you have an object that knows how to do logins as well as synchronize itself with the cloud.

 public class User extends StackMobUser {

     private String email;
     private List<User> friends;
     private List<TaskList> taskLists;

     public User(String username, String password, String email) {
         super(User.class, username, password);
         this.email = email;
     }

     //Add whatever setters/getters/other functionality you want here
 }
 
 

There is a built in concept of username and password, so you shouldn't declare fields for those. You must follow the same rules for fields as you would for StackMobModel. Most likely your app will begin like this

 if(stackmob.isLoggedIn()) {
     User.getLoggedInUser(User.class, new StackMobQueryCallback<User>() {
         public void success(List<User> result) {
             startAppWithUserData(result.get(0));
         }

         public void failure(StackMobException e) {
             // handle failure
         }
     });
 } else {
     // show login screen to get credentials
     final User theUser = new User(username, password);
     theUser.login(new StackMobModelCallback() {
         public void success() {
             startAppWithUserData(theUser);
         }

         public void failure(StackMobException e) {
             // handle failure case
         }
     });
 }
 
 

After either path you've got a confirmed logged in user and their user data.

Constructor Summary

protected	StackMobUser(Class<? extends StackMobUser> actualClass) create a new user of the specified class
protected	StackMobUser(Class<? extends StackMobUser> actualClass, String username) create a new user of the specified class with a username.
protected	StackMobUser(Class<? extends StackMobUser> actualClass, String username, String password) create a new user of the specified class with a username and password.

Method Summary

void	createWithFacebook(String facebookToken, StackMobCallback callback) create this user on StackMob and associate it with an existing Facebook user via Facebook credentials.
void	createWithTwitter(String twitterToken, String twitterSecret, StackMobCallback callback) create thsi user on StackMob and associate it with an existing Twitter user via Twitter credentials.
void	getFacebookUserInfo(StackMobRawCallback callback) get facebook user info for the current user.
String	getIDFieldName() Determines the field name for the primary key on the server.
static <T extends StackMobUser> void	getLoggedInUser(Class<T> classOfT, StackMobOptions options, StackMobQueryCallback<T> callback) Get the currently logged in user.
static <T extends StackMobUser> void	getLoggedInUser(Class<T> classOfT, StackMobQueryCallback<T> callback) Get the currently logged in user.
static String	getLoggedInUsername() get the username for the logged in user, if one exists
void	getPushTokens(StackMobRawCallback callback) retrieve the push tokens associated with this user
String	getSchemaName() The name of the schema this object corresponds to on the server.
void	getTwitterUserInfo(StackMobRawCallback callback) get twitter user info for the current user.
String	getUsername() get the username, which also serves as a primary key
boolean	isLoggedIn() check if the user is logged in
void	linkWithFacebook(String facebookToken, StackMobCallback callback) link an user with an existing Facebook user via Facebook credentials.
void	linkWithTwitter(String twitterToken, String twitterSecret, StackMobCallback callback) link an user with an existing Facebook user via Facebook credentials.
protected void	login(Map<String,String> args, StackMobOptions options, StackMobCallback callback) log this user into StackMob with specialized info.
void	login(StackMobCallback callback) log this user into StackMob.
void	login(StackMobOptions options, StackMobCallback callback) log this user into StackMob.
void	loginResettingTemporaryPassword(String newPassword, StackMobCallback callback) log this user into StackMob with their temporary password and reset their password.
void	loginResettingTemporaryPassword(String newPassword, StackMobOptions options, StackMobCallback callback) log this user into StackMob with their temporary password and reset their password.
void	loginWithFacebook(String facebookToken, StackMobCallback callback) login to StackMob with Facebook credentials.
void	loginWithFacebook(String facebookToken, StackMobOptions options, StackMobCallback callback) login to StackMob with Facebook credentials.
void	loginWithGigya(String gigyaUid, String timestamp, String sig, StackMobOptions options, StackMobCallback callback) login to StackMob with gigya credentials.
void	loginWithTwitter(String twitterToken, String twitterSecret, StackMobCallback callback) login to StackMob with twitter credentials.
void	loginWithTwitter(String twitterToken, String twitterSecret, StackMobOptions options, StackMobCallback callback) login to StackMob with twitter credentials.
void	logout(StackMobCallback callback) log the user out, clearing all credential
void	postFacebookMessage(String msg, StackMobRawCallback callback) post a message to Facebook.
void	postTwitterUpdate(String message, StackMobRawCallback callback) update the logged in users’s Twitter status.
static <T extends StackMobUser> void	pushToMultiple(Map<String,String> payload, List<T> users, StackMobRawCallback callback) send a push notification to a group of users.
void	refreshLogin(StackMobCallback callback) Refresh the current OAuth2 login.
boolean	refreshRequired() check whether a refreshLogin(com.stackmob.sdk.callback.StackMobCallback) call is required to continue making authenticated requests.
void	registerForPush(StackMobPushToken token, StackMobRawCallback callback) register this user for push
void	removeFromPush(StackMobPushToken token, StackMobRawCallback callback) remove this token from push
void	resetPassword(String oldPassword, String newPassword, StackMobCallback callback) reset this user's passwords.
void	save(StackMobOptions options, StackMobCallback callback) Save the object to the server with options.
void	sendPush(Map<String,String> payload, StackMobRawCallback callback) send a push message to this user
static void	sentForgotPasswordEmail(String username, StackMobCallback callback) send out a password reset email to a user who's forgotten their password

Methods inherited from class com.stackmob.sdk.model.StackMobModel

append, appendAndSave, count, destroy, destroy, fetch, fetch, fillFromJson, getID, hasData, newFromJson, query, query, remove, removeAndDelete, save, save, save, saveMultiple, setID, toJson, toJson

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

StackMobUser

protected StackMobUser(Class<? extends StackMobUser> actualClass,
                       String username,
                       String password)

create a new user of the specified class with a username and password.

Parameters:

actualClass - the subclass being constructed

username - the user's username

password - the user's password

StackMobUser

protected StackMobUser(Class<? extends StackMobUser> actualClass,
                       String username)

create a new user of the specified class with a username.

Parameters:

actualClass - the subclass being constructed

username - the user's username

StackMobUser

protected StackMobUser(Class<? extends StackMobUser> actualClass)

create a new user of the specified class

Parameters:

actualClass - the subclass being constructed

Method Detail

save

public void save(StackMobOptions options,
                 StackMobCallback callback)

Description copied from class: StackMobModel

Save the object to the server with options. Use StackMobOptions#depthOf(int) to also save its children to the given depth.

Overrides:

save in class StackMobModel

Parameters:

options - options, such and select and expand, to apply to the request

callback - invoked when the save is complete

sentForgotPasswordEmail

public static void sentForgotPasswordEmail(String username,
                                           StackMobCallback callback)

send out a password reset email to a user who's forgotten their password

Parameters:

username - the user who's forgotten their password

callback - callback to be called when the server returns. may execute in a separate thread

pushToMultiple

public static <T extends StackMobUser> void pushToMultiple(Map<String,String> payload,
                                                           List<T> users,
                                                           StackMobRawCallback callback)

send a push notification to a group of users.

Parameters:

payload - the payload to send

callback - callback to be called when the server returns. may execute in a separate thread

getLoggedInUser

public static <T extends StackMobUser> void getLoggedInUser(Class<T> classOfT,
                                                            StackMobQueryCallback<T> callback)

Get the currently logged in user. Use to get the user object in place of login when you're starting your app and you find that you're still logged in (via StackMob.isLoggedIn()).

Parameters:

classOfT - The class of the user model

callback - The callback to invoke with the user model

getLoggedInUser

public static <T extends StackMobUser> void getLoggedInUser(Class<T> classOfT,
                                                            StackMobOptions options,
                                                            StackMobQueryCallback<T> callback)

Get the currently logged in user. Use to get the user object in place of login when you're starting your app and you find that you're still logged in (via StackMob.isLoggedIn()).

Parameters:

classOfT - The class of the user model

options - additional options, such as headers, to modify the request

callback - The callback to invoke with the user model

getLoggedInUsername

public static String getLoggedInUsername()

get the username for the logged in user, if one exists

Returns:

the logged in user's username

getSchemaName

public String getSchemaName()

Description copied from class: StackMobModel

The name of the schema this object corresponds to on the server. To override, create the following static method in your sublcass: *

 public static String overrideSchemaName() {
     return "thenameyouwant";
 }
 
 

The static method is necessary for the name to be accessible from static method By default it's the name of the class in lower case. Must be less than 25 alphanumeric characters.

Overrides:

getSchemaName in class StackMobModel

Returns:

the schema name

getIDFieldName

public String getIDFieldName()

Description copied from class: StackMobModel

Determines the field name for the primary key on the server. By default it's the name of the class in lower case plus "_id". Override in subclasses to change that. Must be 3-25 alphanumeric characters

Overrides:

getIDFieldName in class StackMobModel

Returns:

the id field name

getUsername

public String getUsername()

get the username, which also serves as a primary key

Returns:

the username

login

protected void login(Map<String,String> args,
                     StackMobOptions options,
                     StackMobCallback callback)

log this user into StackMob with specialized info. This will clear the password from the class.

Parameters:

args - key value pair arguments

options - additional options, such as headers, to modify the request

callback - invoked on completed login attempt

login

public void login(StackMobCallback callback)

log this user into StackMob. This will clear the password from the class.

Parameters:

callback - invoked on completed login attempt

login

public void login(StackMobOptions options,
                  StackMobCallback callback)

log this user into StackMob. This will clear the password from the class.

Parameters:

options - additional options, such as headers, to modify the request

callback - invoked on completed login attempt

loginResettingTemporaryPassword

public void loginResettingTemporaryPassword(String newPassword,
                                            StackMobCallback callback)

log this user into StackMob with their temporary password and reset their password. This should be used when the StackMobRawCallback.temporaryPasswordResetRequired(com.stackmob.sdk.exception.StackMobException) callback is called. This is used as part of the forgot password flow

Parameters:

callback - invoked on completed login attempt

loginResettingTemporaryPassword

public void loginResettingTemporaryPassword(String newPassword,
                                            StackMobOptions options,
                                            StackMobCallback callback)

log this user into StackMob with their temporary password and reset their password. This should be used when the StackMobRawCallback.temporaryPasswordResetRequired(com.stackmob.sdk.exception.StackMobException) callback is called. This is used as part of the forgot password flow

Parameters:

options - additional options, such as headers, to modify the request

callback - invoked on completed login attempt

loginWithFacebook

public void loginWithFacebook(String facebookToken,
                              StackMobCallback callback)

login to StackMob with Facebook credentials. The credentials should match a existing user object that has a linked Facebook account, via either createWithFacebook(String, com.stackmob.sdk.callback.StackMobCallback) or linkWithFacebook(String, com.stackmob.sdk.callback.StackMobCallback)

Parameters:

facebookToken - the facebook user token

callback - callback to be called when the server returns. may execute in a separate thread

loginWithFacebook

public void loginWithFacebook(String facebookToken,
                              StackMobOptions options,
                              StackMobCallback callback)

login to StackMob with Facebook credentials. The credentials should match a existing user object that has a linked Facebook account, via either createWithFacebook(String, com.stackmob.sdk.callback.StackMobCallback) or linkWithFacebook(String, com.stackmob.sdk.callback.StackMobCallback)

Parameters:

facebookToken - the facebook user token

options - additional options, such as headers, to modify the request

callback - callback to be called when the server returns. may execute in a separate thread

loginWithTwitter

public void loginWithTwitter(String twitterToken,
                             String twitterSecret,
                             StackMobCallback callback)

login to StackMob with twitter credentials. The credentials should match a existing user object that has a linked Twitter account, via either createWithTwitter(String, String, com.stackmob.sdk.callback.StackMobCallback) or linkWithTwitter(String, String, com.stackmob.sdk.callback.StackMobCallback)

Parameters:

twitterToken - the twitter session key (this is a per user key - different from the consumer key)

twitterSecret - the twitter session secret (this is a per user secret - different from the consumer secret)

callback - callback to be called when the server returns. may execute in a separate thread

loginWithTwitter

public void loginWithTwitter(String twitterToken,
                             String twitterSecret,
                             StackMobOptions options,
                             StackMobCallback callback)

login to StackMob with twitter credentials. The credentials should match a existing user object that has a linked Twitter account, via either createWithTwitter(String, String, com.stackmob.sdk.callback.StackMobCallback) or linkWithTwitter(String, String, com.stackmob.sdk.callback.StackMobCallback)

Parameters:

twitterToken - the twitter session key (this is a per user key - different from the consumer key)

twitterSecret - the twitter session secret (this is a per user secret - different from the consumer secret)

options - additional options, such as headers, to modify the request

callback - callback to be called when the server returns. may execute in a separate thread

loginWithGigya

public void loginWithGigya(String gigyaUid,
                           String timestamp,
                           String sig,
                           StackMobOptions options,
                           StackMobCallback callback)

login to StackMob with gigya credentials. If a corresponding StackMob user didn't exist before, it will be created.

Parameters:

gigyaUid - The parameter UID

timestamp - The parameter signatureTimestamp

sig - The parameter UIDSignature

options - additional options, such as headers, to modify the request

callback - callback to be called when the server returns. may execute in a separate thread

refreshLogin

public void refreshLogin(StackMobCallback callback)

Refresh the current OAuth2 login. This ordinarily happens automatically, but this method can give you finer control if you need it. Logins last an hour by default. Once they expire they need to be refreshed. Make sure not to send multiple refresh token requests.

Parameters:

callback - callback to be called when the server returns. may execute in a separate thread

logout

public void logout(StackMobCallback callback)

log the user out, clearing all credential

Parameters:

callback - invoked when logout is complete

isLoggedIn

public boolean isLoggedIn()

check if the user is logged in

Returns:

whether the user is logged in

refreshRequired

public boolean refreshRequired()

check whether a refreshLogin(com.stackmob.sdk.callback.StackMobCallback) call is required to continue making authenticated requests. This will happen automatically, so there's no reason to check this method unless you're overriding the existing refresh token system. If there are no credentials at all this will be false.

Returns:

whether there's a valid refresh token that can be used to refresh the login

createWithFacebook

public void createWithFacebook(String facebookToken,
                               StackMobCallback callback)

create this user on StackMob and associate it with an existing Facebook user via Facebook credentials.

Parameters:

facebookToken - the facebook user token

callback - callback to be called when the server returns. may execute in a separate thread

createWithTwitter

public void createWithTwitter(String twitterToken,
                              String twitterSecret,
                              StackMobCallback callback)

create thsi user on StackMob and associate it with an existing Twitter user via Twitter credentials.

Parameters:

twitterToken - the twitter session key (this is a per user key - different from the consumer key)

twitterSecret - the twitter session secret (this is a per user secret - different from the consumer secret)

callback - callback to be called when the server returns. may execute in a separate thread

linkWithFacebook

public void linkWithFacebook(String facebookToken,
                             StackMobCallback callback)

link an user with an existing Facebook user via Facebook credentials. The user must be logged in

Parameters:

facebookToken - the Facebook user token

callback - callback to be called when the server returns. may execute in a separate thread

linkWithTwitter

public void linkWithTwitter(String twitterToken,
                            String twitterSecret,
                            StackMobCallback callback)

link an user with an existing Facebook user via Facebook credentials. The user must be logged in

Parameters:

twitterToken - the twitter session key (this is a per user key - different from the consumer key)

twitterSecret - the twitter session secret (this is a per user secret - different from the consumer secret)

callback - callback to be called when the server returns. may execute in a separate thread

postFacebookMessage

public void postFacebookMessage(String msg,
                                StackMobRawCallback callback)

post a message to Facebook. This method will not post to FB and will return nothing if there is no user logged into FB.

Parameters:

msg - the message to post

callback - callback to be called when the server returns. may execute in a separate thread

postTwitterUpdate

public void postTwitterUpdate(String message,
                              StackMobRawCallback callback)

update the logged in users’s Twitter status. The logged in user must have a linked Twitter account.

Parameters:

message - the message to send. must be <= 140 characters

callback - callback to be called when the server returns. may execute in a separate thread

getFacebookUserInfo

public void getFacebookUserInfo(StackMobRawCallback callback)

get facebook user info for the current user. this method will return nothing if there is no currently logged in FB user

Parameters:

callback - callback to be called when the server returns. may execute in a separate thread

getTwitterUserInfo

public void getTwitterUserInfo(StackMobRawCallback callback)

get twitter user info for the current user. this method will return nothing if there is no currently logged in twitter user

Parameters:

callback - callback to be called when the server returns. may execute in a separate thread

resetPassword

public void resetPassword(String oldPassword,
                          String newPassword,
                          StackMobCallback callback)

reset this user's passwords. Passwords cannot be changed directly when saving objects.

Parameters:

oldPassword - the users' old password

newPassword - the new password

callback - invoked upon completed reset

registerForPush

public void registerForPush(StackMobPushToken token,
                            StackMobRawCallback callback)

register this user for push

Parameters:

token - the Android registration id to associate with this user

callback - invoked when the operation is complete

sendPush

public void sendPush(Map<String,String> payload,
                     StackMobRawCallback callback)

send a push message to this user

Parameters:

payload - the message to send

callback - invoked when the operation is complete

removeFromPush

public void removeFromPush(StackMobPushToken token,
                           StackMobRawCallback callback)

remove this token from push

Parameters:

token - the token to remove

callback - invoked when the operation is complete

getPushTokens

public void getPushTokens(StackMobRawCallback callback)

retrieve the push tokens associated with this user

Parameters:

callback - invoked when the operation is complete