com.microstrategy.ushersdk

Class AccountManager

java.lang.Object

com.microstrategy.ushersdk.AccountManager

All Implemented Interfaces:

android.arch.lifecycle.LifecycleObserver

public class AccountManager
extends java.lang.Object
implements android.arch.lifecycle.LifecycleObserver

The AccountManager class collects all of the APIs related to account management. Account management includes processes such as registering a user, signing in, signing out, and updating user information. Each account is tied to a single user. All of these methods will be executed on a background thread and return the result on the main thread. To receive the result, you are expected to pass a corresponding SingleCallback or CompleteCallback.

Constructor Summary

Constructors

Constructor and Description
AccountManager(android.support.v7.app.AppCompatActivity appCompatActivity) Constructor for an AccountManager object with the lifecycle set.
AccountManager(android.support.v4.app.Fragment fragment) Constructor for an AccountManager object with the lifecycle set.
AccountManager(android.arch.lifecycle.Lifecycle lifecycle) Constructor for an AccountManager object with the lifecycle set.

Method Summary

Modifier and Type	Method and Description
void	checkExistence(java.lang.String email, SingleCallback<java.lang.Boolean> callback) Returns a boolean that represents whether or not a user account exists in the system.
void	checkExistenceAndGetPhoneNumber(java.lang.String email, SingleCallback<java.lang.String> callback) Returns a String that represents a user's masked phone number in the system.
void	deleteAccount(CompleteCallback callback) Returns a CompleteCallback after deleting an account.
void	disableBiometricsSignIn(CompleteCallback callback) Returns a CompleteCallback after disabling biometrics log in for a user account.
void	enableBiometricsSignIn(ObservableCallback<FingerprintVerificationResult> callback) Returns a FingerprintVerificationResult object after enabling biometric login for a user account.
void	fetch(SingleCallback<UserEntity> callback) Returns a UserEntity object, which contains properties related to the user account that is currently logged in.
void	fetchToken(SingleCallback<java.lang.String> callback) Returns a String of the access token after requesting a new access token to authenticate with the server.
void	get(SingleCallback<UserEntity> callback) Returns a UserEntity object, which contains properties related to the user account that is currently logged in.
void	getAccountPolicyEntity(SingleCallback<AccountPolicyEntity> callback) Returns an AccountPolicyEntity object.
void	getAppCodeSettings(SingleCallback<AppCodeEntity> callback) Returns an AppCodeEntity object for the account that is currently logged in.
java.lang.String	getToken() Returns a String of the access token that is being used to authenticate with the server.
boolean	hasUser() Returns a boolean that represents whether or not a user has ever signed in, regardless of the current authentication status.
boolean	isAuthenticated() Returns a boolean that represents whether or not the user account is currently signed in and authenticated.
boolean	isBiometricsSignInEnabled() Returns a boolean that represents whether or not the user account has the option of signing in via biometrics.
boolean	isBiometricsSignInEnabledBefore() Returns a boolean that represents whether or not the user account has enabled signing in via biometrics before.
void	isLoggedInWithTemporaryPassword(SingleCallback<java.lang.Boolean> callback) Returns a boolean that represents whether or not a user is logged in with a temporary password.
boolean	isStaySignedInEnabled() Returns a boolean that represents whether or not the user account has the option of staying signed in between different openings of the app.
void	register(SignUpParam signUpParam, CompleteCallback callback) Returns a CompleteCallback after user account registration.
void	registerAndSignIn(SignUpAndSignInParam signUpAndSignInParam, CompleteCallback callback) Returns a CompleteCallback after user account registration and signing in.
void	signIn(SignInParam signInParam, CompleteCallback callback) Returns a CompleteCallback after signing into the user account.
void	signInWithBiometrics(ObservableCallback<FingerprintVerificationResult> callback) Returns a FingerprintVerificationResult object after signing into a user account with biometrics.
void	signOut(CompleteCallback callback) Returns a CompleteCallback after signing out of the user account.
void	update(AccountParam accountParam, CompleteCallback callback) Returns a CompleteCallback after updating the user account information.
void	updateAppCodeSettings(boolean enable, java.lang.String appCode, CompleteCallback callback) Returns a CompleteCallback after updating the app code settings.
void	updatePhone(java.lang.String phoneNumber, CompleteCallback callback) Returns a CompleteCallback after updating the user contact information.
void	verifyAppCode(java.lang.String appCode, boolean useCache, CompleteCallback callback) Returns a CompleteCallback after verifying the user's app code.
void	verifyAppCode(java.lang.String appCode, CompleteCallback callback) Returns a CompleteCallback after verifying the user's app code on the server.

Methods inherited from class java.lang.Object

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

Constructor Detail

AccountManager

public AccountManager(android.arch.lifecycle.Lifecycle lifecycle)

Constructor for an AccountManager object with the lifecycle set.

Parameters:

lifecycle - See Lifecycle

AccountManager

public AccountManager(android.support.v7.app.AppCompatActivity appCompatActivity)

Constructor for an AccountManager object with the lifecycle set.

Parameters:

appCompatActivity - See AppCompatActivity

AccountManager

public AccountManager(android.support.v4.app.Fragment fragment)

Constructor for an AccountManager object with the lifecycle set.

Parameters:

fragment - See Fragment

Method Detail

checkExistence

public void checkExistence(java.lang.String email,
                           SingleCallback<java.lang.Boolean> callback)

Returns a boolean that represents whether or not a user account exists in the system.

Parameters:

email - the email address of the user account to verify

callback - the callback to receive the verification result. true if the user account exists in the system; false otherwise

checkExistenceAndGetPhoneNumber

public void checkExistenceAndGetPhoneNumber(java.lang.String email,
                                            SingleCallback<java.lang.String> callback)

Returns a String that represents a user's masked phone number in the system.

Parameters:

email - the email address of the user account to verify and get masked phone number

callback - the callback to receive the verification result

deleteAccount

public void deleteAccount(CompleteCallback callback)

Returns a CompleteCallback after deleting an account.

Parameters:

callback - the callback to receive the result of deleting an account

enableBiometricsSignIn

public void enableBiometricsSignIn(ObservableCallback<FingerprintVerificationResult> callback)

Returns a FingerprintVerificationResult object after enabling biometric login for a user account.

Parameters:

callback - the callback to receive the FingerprintVerificationResult object after enabling biometric login for a user account

disableBiometricsSignIn

public void disableBiometricsSignIn(CompleteCallback callback)

Returns a CompleteCallback after disabling biometrics log in for a user account.

Parameters:

callback - the callback to receive the result of disabling biometrics log in

fetch

public void fetch(SingleCallback<UserEntity> callback)

Returns a UserEntity object, which contains properties related to the user account that is currently logged in. This information is retrieved from the server.

Parameters:

callback - the callback to receive the UserEntity object

fetchToken

public void fetchToken(SingleCallback<java.lang.String> callback)

Returns a String of the access token after requesting a new access token to authenticate with the server. In general, this API call should not be made until you are told the previous access token is expired.

Parameters:

callback - the callback to receive the access token

get

public void get(SingleCallback<UserEntity> callback)

Returns a UserEntity object, which contains properties related to the user account that is currently logged in. This information is retrieved from the local cache.

Parameters:

callback - the callback to receive the UserEntity object

getAccountPolicyEntity

public void getAccountPolicyEntity(SingleCallback<AccountPolicyEntity> callback)

Returns an AccountPolicyEntity object.

Parameters:

callback - the callback to receive the AccountPolicyEntity object.

getAppCodeSettings

public void getAppCodeSettings(SingleCallback<AppCodeEntity> callback)

Returns an AppCodeEntity object for the account that is currently logged in. This information is retrieved from the server.

Parameters:

callback - the callback to receive the AppCodeEntity object.

getToken

@Nullable
public java.lang.String getToken()

Returns a String of the access token that is being used to authenticate with the server. Will be null if the session is not authenticated.

Returns:

the access token that is being used to authenticate with the server.

hasUser

public boolean hasUser()

Returns a boolean that represents whether or not a user has ever signed in, regardless of the current authentication status.

Returns:

true if a user has ever signed in, regardless of the current authentication status; false otherwise.

isAuthenticated

public boolean isAuthenticated()

Returns a boolean that represents whether or not the user account is currently signed in and authenticated.

Returns:

true if the user account is currently signed in and authenticated; false otherwise.

isBiometricsSignInEnabled

public boolean isBiometricsSignInEnabled()

Returns a boolean that represents whether or not the user account has the option of signing in via biometrics.

Returns:

true if the user account has the option of signing in via biometrics; false otherwise.

isBiometricsSignInEnabledBefore

public boolean isBiometricsSignInEnabledBefore()

Returns a boolean that represents whether or not the user account has enabled signing in via biometrics before.

Returns:

true if the user account has enabled signing in via biometrics before; false otherwise.

isLoggedInWithTemporaryPassword

public void isLoggedInWithTemporaryPassword(SingleCallback<java.lang.Boolean> callback)

Returns a boolean that represents whether or not a user is logged in with a temporary password.

Parameters:

callback - the callback to receive the result of checking the login status with a temporary password: true if the user is logged in with a temporary password false otherwise

isStaySignedInEnabled

public boolean isStaySignedInEnabled()

Returns a boolean that represents whether or not the user account has the option of staying signed in between different openings of the app.

Returns:

true if the user account has the option of staying signed in between app openings; false otherwise.

register

public void register(SignUpParam signUpParam,
                     CompleteCallback callback)

Returns a CompleteCallback after user account registration.

Parameters:

signUpParam - the parameters needed for user account registration. See SignUpParam

callback - the callback to receive the result of user account registration

registerAndSignIn

public void registerAndSignIn(SignUpAndSignInParam signUpAndSignInParam,
                              CompleteCallback callback)

Returns a CompleteCallback after user account registration and signing in.

Parameters:

signUpAndSignInParam - the parameters needed for user account registration and sign in. See SignUpAndSignInParam

callback - the callback to receive the result of user account registration and signing in

signIn

public void signIn(SignInParam signInParam,
                   CompleteCallback callback)

Returns a CompleteCallback after signing into the user account.

Parameters:

signInParam - the parameters needed for user account sign in. See SignInParam

callback - the callback to receive the result of signing into the user account

signInWithBiometrics

public void signInWithBiometrics(ObservableCallback<FingerprintVerificationResult> callback)

Returns a FingerprintVerificationResult object after signing into a user account with biometrics.

Parameters:

callback - the callback to receive the FingerprintVerificationResult object after signing into a user account with biometrics

signOut

public void signOut(CompleteCallback callback)

Returns a CompleteCallback after signing out of the user account.

Parameters:

callback - the callback to receive the result of signing out of the user account

update

public void update(AccountParam accountParam,
                   CompleteCallback callback)

Returns a CompleteCallback after updating the user account information.

Parameters:

accountParam - the updated parameters for the user account. See AccountParam

callback - the callback to receive the result of updating the user account information

updateAppCodeSettings

public void updateAppCodeSettings(boolean enable,
                                  java.lang.String appCode,
                                  CompleteCallback callback)

Returns a CompleteCallback after updating the app code settings.

Parameters:

enable - true if the user has enabled the use of the app code; false otherwise

appCode - the app code

callback - the callback to receive the result of updating the app code settings

updatePhone

public void updatePhone(java.lang.String phoneNumber,
                        CompleteCallback callback)

Returns a CompleteCallback after updating the user contact information.

Parameters:

phoneNumber - the updated phone number for the user account.

callback - the callback to receive the result of updating the user contact information

verifyAppCode

public void verifyAppCode(java.lang.String appCode,
                          CompleteCallback callback)

Returns a CompleteCallback after verifying the user's app code on the server.

Parameters:

appCode - the app code

callback - the callback to receive the result of verifying the user's app code on the server

verifyAppCode

public void verifyAppCode(java.lang.String appCode,
                          boolean useCache,
                          CompleteCallback callback)

Returns a CompleteCallback after verifying the user's app code. If useCache is true, the verification will check against the cache; otherwise, if useCache is false, the verification will take place on the server. If AppCodeEntity.enabled() is false, it will throw an error.

Parameters:

appCode - the app code

useCache - true if the verification will check against local cache; false if the verification should check against the server

callback - the callback to receive the result of verifying the user's app code