com.onedrive.sdk.authentication

Class MSAAuthenticator

java.lang.Object

com.onedrive.sdk.authentication.MSAAuthenticator

All Implemented Interfaces:

IAuthenticator

public abstract class MSAAuthenticator
extends java.lang.Object
implements IAuthenticator

Wrapper around the MSA authentication library. https://github.com/MSOpenTech/msa-auth-for-android

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	VERSION_CODE_KEY The key for the version code

Constructor Summary

Constructors

Constructor and Description
MSAAuthenticator()

Method Summary

Methods

Modifier and Type	Method and Description
IAccountInfo	getAccountInfo() Gets the current account info for this authenticator.
abstract java.lang.String	getClientId() The client id for this authenticator.
abstract java.lang.String[]	getScopes() The scopes for this application.
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.

Methods inherited from class java.lang.Object

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

Field Detail

VERSION_CODE_KEY

public static final java.lang.String VERSION_CODE_KEY

The key for the version code

See Also:

Constant Field Values

Constructor Detail

MSAAuthenticator

public MSAAuthenticator()

Method Detail

getClientId

public abstract java.lang.String getClientId()

The client id for this authenticator. https://dev.onedrive.com/auth/msa_oauth.htm#to-register-your-app

Returns:

The client id.

getScopes

public abstract java.lang.String[] getScopes()

The scopes for this application. https://dev.onedrive.com/auth/msa_oauth.htm#authentication-scopes

Returns:

The scopes for this application.

init

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

Initializes the authenticator.

Specified by:

init in interface IAuthenticator

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

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

Starts an interactive login asynchronously.

Specified by:

login in interface IAuthenticator

Parameters:

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

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

login

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

Starts an interactive login.

Specified by:

login in interface IAuthenticator

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

public void loginSilent(ICallback<IAccountInfo> loginCallback)

Starts a silent login asynchronously.

Specified by:

loginSilent in interface IAuthenticator

Parameters:

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

loginSilent

public IAccountInfo loginSilent()
                         throws ClientException

Starts a silent login.

Specified by:

loginSilent in interface IAuthenticator

Returns:

The account info.

Throws:

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

logout

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

Log the current user out.

Specified by:

logout in interface IAuthenticator

Parameters:

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

logout

public void logout()
            throws ClientException

Log the current user out.

Specified by:

logout in interface IAuthenticator

Throws:

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

getAccountInfo

public IAccountInfo getAccountInfo()

Gets the current account info for this authenticator.

Specified by:

getAccountInfo in interface IAuthenticator

Returns:

NULL if no account is available.