Package ug.sparkpl.momoapi.models

Class CurrentUserType

java.lang.Object

ug.sparkpl.momoapi.models.CurrentUserType

public abstract class CurrentUserType
extends java.lang.Object

Created by mossplix on 4/27/17.

Constructor Summary

Constructors

Constructor	Description
CurrentUserType()

Method Summary

Modifier and Type	Method	Description
boolean	exists()	Deprecated. Prefer observable()
abstract java.lang.String	getAccessToken()	Get the logged in user's access token.
abstract User	getUser()	Deprecated. Prefer observable()
rx.Observable<java.lang.Boolean>	isLoggedIn()	Emits a boolean that determines if the user is logged in or not.
rx.Observable<User>	loggedInUser()	Emits only values of a logged in user.
rx.Observable<User>	loggedOutUser()	Emits only values of a logged out user.
abstract void	login(User user)
abstract void	login(User newUser, java.lang.String accessToken)	Call when a user has logged in.
abstract void	logout()	Call when a user should be logged out.
abstract rx.Observable<User>	observable()	Returns an observable representing the current user.
abstract void	refresh(User freshUser)	Updates the persisted current user with a fresh, new user.

Methods inherited from class java.lang.Object

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

Constructor Detail

CurrentUserType

public CurrentUserType()

Method Detail

login

public abstract void login(@NonNull
                           User newUser,
                           @NonNull
                           java.lang.String accessToken)

Call when a user has logged in. The implementation of `CurrentUserType` is responsible for persisting the user and access token.

login

public abstract void login(User user)

logout

public abstract void logout()

Call when a user should be logged out.

getAccessToken

@Nullable
public abstract java.lang.String getAccessToken()

Get the logged in user's access token.

refresh

public abstract void refresh(@NonNull
                             User freshUser)

Updates the persisted current user with a fresh, new user.

observable

@NonNull
public abstract rx.Observable<User> observable()

Returns an observable representing the current user. It emits immediately with the current user, and then again each time the user is updated.

getUser

@Deprecated
@Nullable
public abstract User getUser()

Deprecated.

Prefer observable()

Returns the most recently emitted user from the user observable.

exists

@Deprecated
public boolean exists()

Deprecated.

Prefer observable()

Returns a boolean that determines if there is a currently logged in user or not.

isLoggedIn

@NonNull
public rx.Observable<java.lang.Boolean> isLoggedIn()

Emits a boolean that determines if the user is logged in or not. The returned observable will emit immediately with the logged in state, and then again each time the current user is updated.

loggedInUser

@NonNull
public rx.Observable<User> loggedInUser()

Emits only values of a logged in user. The returned observable may never emit.

loggedOutUser

@NonNull
public rx.Observable<User> loggedOutUser()

Emits only values of a logged out user. The returned observable may never emit.