com.inrix.sdk

Class UserManager

java.lang.Object

com.inrix.sdk.UserManager

public class UserManager
extends Object

Provides access to the API to create users and authenticate existing users.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	UserManager.ChangePasswordListener Response listener for change password request.
static class	UserManager.ChangePasswordOptions Change password request options.
static interface	UserManager.ResetPasswordListener Response listener for reset password request.
static class	UserManager.ResetPasswordOptions Reset password options.
static interface	UserManager.UpdatePushNotificationInformationListener Response listener for update push notification information.
static class	UserManager.UpdatePushNotificationInformationOptions Update user's push notification information options.
static interface	UserManager.UserCreateListener Create new user account response listener.
static class	UserManager.UserCreateOptions Create user options.
static interface	UserManager.UserGetListener Get user information response listener.
static class	UserManager.UserGetOptions Get user account options.
static class	UserManager.UserManagerException An exception that is thrown when there is an error with a TripManager operation.
static interface	UserManager.UserSignInListener User sign in response listener.
static class	UserManager.UserSignInOptions User sign in options.
static interface	UserManager.UserSignOutListener User sign out response listener.
static interface	UserManager.UserUpdateListener Create new user update response listener.
static class	UserManager.UserUpdateOptions Update user options.

Method Summary

Methods

Modifier and Type	Method and Description
ICancellable	changePassword(UserManager.ChangePasswordOptions options, UserManager.ChangePasswordListener listener) Change account password.
ICancellable	create(UserManager.UserCreateOptions options, UserManager.UserCreateListener listener) Creates a new user account.
String	getSignInName() Gets the current user sign in name.
ICancellable	getUserInformation(UserManager.UserGetOptions options, UserManager.UserGetListener listener) Gets information about current user.
boolean	isAuthenticated() Gets the value indicating if user, anonymous or not, is authenticated.
boolean	isSignedIn() Gets the value indicating if user if signed in or not.
ICancellable	resetPassword(UserManager.ResetPasswordOptions options, UserManager.ResetPasswordListener listener) Resets account password.
ICancellable	signIn(UserManager.UserSignInOptions options, UserManager.UserSignInListener listener) Sign in with existing user account.
ICancellable	signOut(UserManager.UserSignOutListener listener) Sign out current user.
ICancellable	update(UserManager.UserUpdateOptions options, UserManager.UserUpdateListener listener) Updates a user account.
ICancellable	updatePushNotificationInformation(UserManager.UpdatePushNotificationInformationOptions options, UserManager.UpdatePushNotificationInformationListener listener) Update push information for current user.

Methods inherited from class java.lang.Object

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

Method Detail

update

public ICancellable update(@NonNull
                  UserManager.UserUpdateOptions options,
                  @NonNull
                  UserManager.UserUpdateListener listener)

Updates a user account.

Parameters:

options - User account options.

listener - Response listener that is called when user account is updated.

Returns:

An instance of ICancellable to cancel current request.

create

public ICancellable create(@NonNull
                  UserManager.UserCreateOptions options,
                  @NonNull
                  UserManager.UserCreateListener listener)

Creates a new user account.

Parameters:

options - User account options.

listener - Response listener that is called when user account is created.

Returns:

An instance of ICancellable to cancel current request.

signIn

public ICancellable signIn(@NonNull
                  UserManager.UserSignInOptions options,
                  @NonNull
                  UserManager.UserSignInListener listener)

Sign in with existing user account.

Parameters:

options - User account sign in options.

listener - Response listener that is called when user signed in.

Returns:

An instance of ICancellable to cancel current request.

getUserInformation

public ICancellable getUserInformation(@NonNull
                              UserManager.UserGetOptions options,
                              @NonNull
                              UserManager.UserGetListener listener)

Gets information about current user.

Parameters:

options - User account information.

listener - Response listener that is called when user information is received.

Returns:

An instance of ICancellable to cancel current request.

signOut

public ICancellable signOut(@NonNull
                   UserManager.UserSignOutListener listener)

Sign out current user.

Parameters:

listener - Response listener that is called when user is signed out.

Returns:

An instance of ICancellable to cancel current request.

updatePushNotificationInformation

public ICancellable updatePushNotificationInformation(@NonNull
                                             UserManager.UpdatePushNotificationInformationOptions options,
                                             @NonNull
                                             UserManager.UpdatePushNotificationInformationListener listener)

Update push information for current user.

Push information must be updated for the user to be able to receive push notifications.

Parameters:

options - User push notification information.

listener - Response listener that is called when push information is updated

Returns:

An instance of ICancellable to cancel current request.

resetPassword

public ICancellable resetPassword(@NonNull
                         UserManager.ResetPasswordOptions options,
                         @NonNull
                         UserManager.ResetPasswordListener listener)

Resets account password.

Parameters:

options - Reset password options.

listener - Response listener.

Returns:

An instance of ICancellable to cancel the request.

changePassword

public ICancellable changePassword(UserManager.ChangePasswordOptions options,
                          UserManager.ChangePasswordListener listener)

Change account password. All active user sessions, including current session on device, will be terminated. User must sign in again to start another session.

Parameters:

options - Change password options.

listener - Response listener.

Returns:

An instance of ICancellable to cancel the request.

isSignedIn

public boolean isSignedIn()

Gets the value indicating if user if signed in or not.

Returns:

true if user is signed in with valid credentials; otherwise false.

isAuthenticated

public boolean isAuthenticated()

Gets the value indicating if user, anonymous or not, is authenticated.

Returns:

true if user is authenticated; otherwise false.

getSignInName

public String getSignInName()

Gets the current user sign in name.

Returns:

Current user sign in name.