com.onedrive.sdk.authentication

Interface IAuthenticator

All Known Implementing Classes:

ADALAuthenticator, DisambiguationAuthenticator, MSAAuthenticator

public interface IAuthenticator

Authenticates a user interactively and silently.

Method Summary

Methods

Modifier and Type	Method and Description
IAccountInfo	getAccountInfo() Gets the current account info for this authenticator.
void	init(IExecutors executors, IHttpProvider httpProvider, android.app.Activity activity, ILogger logger) Initializes the authenticator.
IAccountInfo	login(java.lang.String emailAddressHint) Starts an interactive login.
void	login(java.lang.String emailAddressHint, ICallback<IAccountInfo> loginCallback) Starts an interactive login asynchronously.
IAccountInfo	loginSilent() Starts a silent login.
void	loginSilent(ICallback<IAccountInfo> loginCallback) Starts a silent login asynchronously.
void	logout() Log the current user out.
void	logout(ICallback<java.lang.Void> logoutCallback) Log the current user out.

Method Detail

getAccountInfo

IAccountInfo getAccountInfo()

Gets the current account info for this authenticator.

Returns:

NULL if no account is available.

init

void init(IExecutors executors,
        IHttpProvider httpProvider,
        android.app.Activity activity,
        ILogger logger)

Initializes the authenticator.

Parameters:

executors - The executors to schedule foreground and background tasks.

httpProvider - The http provider for sending requests.

activity - The activity to create interactive UI on.

logger - The logger for diagnostic information.

login

void login(java.lang.String emailAddressHint,
         ICallback<IAccountInfo> loginCallback)

Starts an interactive login asynchronously.

Parameters:

emailAddressHint - The hint for the email address during the interactive login.

loginCallback - The callback to be called when the login is complete.

login

IAccountInfo login(java.lang.String emailAddressHint)
                   throws ClientException

Starts an interactive login.

Parameters:

emailAddressHint - The hint for the email address during the interactive login.

Returns:

The account info.

Throws:

ClientException - An exception occurs if the login was unable to complete for any reason.

loginSilent

void loginSilent(ICallback<IAccountInfo> loginCallback)

Starts a silent login asynchronously.

Parameters:

loginCallback - The callback to be called when the login is complete.

loginSilent

IAccountInfo loginSilent()
                         throws ClientException

Starts a silent login.

Returns:

The account info.

Throws:

ClientException - If the login was unable to complete for any reason.

logout

void logout(ICallback<java.lang.Void> logoutCallback)

Log the current user out.

Parameters:

logoutCallback - The callback to be called when the logout is complete.

logout

void logout()
            throws ClientException

Log the current user out.

Throws:

ClientException - Indicates if the logout was unable to complete for any reason.