Documentation > Smart Spaces > Developers > Mobile SDK > Android > User Manager

User Manager

The User Manager

To acquire the single instance of the UserManager call sdk.getUserManager().

The logged status of the user can be observed from the getStatusLiveData() method.
Possible values and their expected values are:

NotLoggedIn: Initial state
Initializing: Either user was previously logged-in and the UserManager is recovering the saved information on a background thread; or a login command was just executed and it’s being processed. On both cases the status should update shortly.
Ready: The Login/Initialization completed successfully and the functions of the UserManager can be used.
LoggingOut: A logout execution have been triggered and it’s being processed

Additionally NotLoggedIn and LoggingOut contains a user-friendly message string and a Reason enum.
When a LoggingOut occurs, the message and reason will be copied over to the following NotLoggedIn status.
The Reason values are:

NotLoggedIn: Initial state as soon as the UserManager is instantiated.
UserNotAuthorised: The user is not authorized with the Smartspaces backend. This might happen due to a login failed (wrong username/password/token) or due to a revoked authorization on the backend side (HTTP-⁴⁰¹⁄₄₀₃).
EncryptionFailure: There was a problem initializing the SDK due to an encryption issue. The data is cleared during LoggingOut and a new call to login() should pass without issues on the next attempt.
ClientApplicationRequestedLogout: The client app called the logout() method.

The UserManager provides 3 different types of login for the user

Username and Password
OAuth2
external Token Login

val result : LiveData<SimpleResponse<Void>> = userManager.usernamePasswordLoginLiveData(username, password)
result.observe(this)
      .onSuccess {
        // login success
      }
      .onFail { exception ->
        // login fail
      }

Java

LiveData<Response<Void, Void>> result = userManager.usernamePasswordLoginLiveData(username, password);
result.observe(this, new ResponseObserver<Void, Void>() {
  @Override public void onSuccess(@Nullable Void aVoid) {
    // login success
  }

  @Override public void onFail(@Nullable Exception exception) {
    // login fail
  }
});

To login with OAuth2 you have to do the login in an external Webview and add a deep-link back into the app.
The deep-link URI have to be configured on the backend.
The URL to call for the external url consists of the BASE_URL + /auth/ + OAUTH_ID

Kotlin

val uri = Uri.parse("${baseUrl}/auth/${oauthId}")
CustomTabsIntent.Builder()
    .build()
    .launchUrl(activity, uri)

Java

Uri uri = Uri.parse(baseUrl + "/auth/" + oAuthId);
new CustomTabsIntent.Builder()
        .build()
        .launchUrl(this, uri);

We recommend the use CustomTabsIntent class of Android. All security conscious oauth2 providers blocks the usage of built-in WebView. To use the CustomTabsIntent you have to add implementation "com.android.support:customtabs:<latest>" as a dependency into your build.gradle file

After the login succeeded the WebView will deep-link back into your application which will receive the redirectedUrl on the Intent to login to the SDK.

Kotlin

val result : LiveData<SimpleResponse<Void>>  = userManager.oAuth2LoginLiveData(intent.dataString)

Java

LiveData<Response<Void, Void>> result = userManager.oAuth2LoginLiveData(intent.getDataString());

The result of the login operation can be observed similarly to the username and password login

To login the user using server-to-server pre-shared authentication token your backend has to register a token for the user on the Smartspaces Server and provide it to the following method.

Kotlin

val result : LiveData<SimpleResponse<Void>> = userManager.externalTokenLoginLiveData(authToken)

Java

LiveData<Response<Void, Void>> result = userManager.externalTokenLoginLiveData(authToken);

The result of the login operation can be observed similarly to the username and password login

If the login failed the state of the UserManager will be UserManager.Status.NotAuthorized and then UserManager.Status.NotLoggedIn for all login variations. UserManager.Status.NotAuthorized also has a message string with the explanation, why the authorization failed.

Logout

To logout a user simply call the logout() method:

userManager.logout()

Java

userManager.logout();

This method doesn’t return a LiveData<Response> because its result can be directly observed on the UserManager status

Change Password

You can only change the password, if you are using login via username and password

You can change the password of a logged in user, like in the following example:

val result : LiveData<SimpleResponse<Void>> = userManager.changePasswordLiveData(oldPassword, newPassword, newPasswordConfirm)
result.observe(this)
      .onSuccess {
        // change password success
      }
      .onFail { exception ->
        // change password fail
      }

Java

LiveData<Response<Void, Void>> result = userManager.changePasswordLiveData(oldPassword, newPassword, newPasswordConfirm);
result.observe(this, new ResponseObserver<Void, Void>() {
  @Override public void onSuccess(@Nullable Void aVoid) {
    // change password success
  }

  @Override public void onFail(@Nullable Exception exception) {
    // change password fail
  }
});

User

To get all available user information (f.e. email, firstname, lastname, salutation) use the following code

Kotlin

val user : LiveData<User> = userManager.getUserLiveData().onSuccess()
user.observe(this, Observer { user ->
    user?.let {

    }
})

Java

LiveData<Response<User, Void>> user = userManager.getUserLiveData();
ResponseExtensionsKt.onSuccess(user).observe(this, new Observer<User>() {
	@Override public void onChanged(@Nullable User user) {
    if(user != null) {

    }
	}
});

User Manager

The User Manager

Kotlin

Java

`Uri uri = Uri.parse(baseUrl + "/auth/" + oAuthId); new CustomTabsIntent.Builder() .build() .launchUrl(this, uri);`

Kotlin

Java

`LiveData<Response<Void, Void>> result = userManager.oAuth2LoginLiveData(intent.getDataString());`

Kotlin

Java

`LiveData<Response<Void, Void>> result = userManager.externalTokenLoginLiveData(authToken);`

Logout

Java

`userManager.logout();`

Change Password

User

Kotlin

Java

`LiveData<Response<User, Void>> user = userManager.getUserLiveData(); ResponseExtensionsKt.onSuccess(user).observe(this, new Observer<User>() { @Override public void onChanged(@Nullable User user) { if(user != null) { } } });`

User Manager

The User Manager

Login

Login via username and password

Login via OAuth2

Kotlin

Java Uri uri = Uri.parse(baseUrl + "/auth/" + oAuthId); new CustomTabsIntent.Builder() .build() .launchUrl(this, uri);

Kotlin

Java LiveData<Response<Void, Void>> result = userManager.oAuth2LoginLiveData(intent.getDataString());

Login using external Token

Kotlin

Java LiveData<Response<Void, Void>> result = userManager.externalTokenLoginLiveData(authToken);

Login failed

Logout

Java userManager.logout();

Change Password

User

Kotlin

Java LiveData<Response<User, Void>> user = userManager.getUserLiveData(); ResponseExtensionsKt.onSuccess(user).observe(this, new Observer<User>() { @Override public void onChanged(@Nullable User user) { if(user != null) { } } });

Java

`Uri uri = Uri.parse(baseUrl + "/auth/" + oAuthId); new CustomTabsIntent.Builder() .build() .launchUrl(this, uri);`

Java

`LiveData<Response<Void, Void>> result = userManager.oAuth2LoginLiveData(intent.getDataString());`

Java

`LiveData<Response<Void, Void>> result = userManager.externalTokenLoginLiveData(authToken);`

Java

`userManager.logout();`

Java

`LiveData<Response<User, Void>> user = userManager.getUserLiveData(); ResponseExtensionsKt.onSuccess(user).observe(this, new Observer<User>() { @Override public void onChanged(@Nullable User user) { if(user != null) { } } });`