com.microsoft.services.msa

Class LiveAuthClient

java.lang.Object

com.microsoft.services.msa.LiveAuthClient

public class LiveAuthClient
extends java.lang.Object

LiveAuthClient is a class responsible for retrieving a LiveConnectSession, which provides authentication information for calls to Live APIs.

Constructor Summary

Constructors

Constructor and Description
LiveAuthClient(android.content.Context context, java.lang.String clientId)
LiveAuthClient(android.content.Context context, java.lang.String clientId, java.lang.Iterable<java.lang.String> scopes)
LiveAuthClient(android.content.Context context, java.lang.String clientId, java.lang.Iterable<java.lang.String> scopes, OAuthConfig oAuthConfig) Constructs a new LiveAuthClient instance and initializes its member variables.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getClientId()
LiveConnectSession	getSession()
void	login(android.app.Activity activity, java.lang.Iterable<java.lang.String> scopes, LiveAuthListener listener)
void	login(android.app.Activity activity, java.lang.Iterable<java.lang.String> scopes, java.lang.Object userState, LiveAuthListener listener)
void	login(android.app.Activity activity, java.lang.Iterable<java.lang.String> scopes, java.lang.Object userState, java.lang.String loginHint, LiveAuthListener listener) Logs in an user with the given scopes and additional saved state.
void	login(android.app.Activity activity, LiveAuthListener listener)
java.lang.Boolean	loginSilent(java.lang.Iterable<java.lang.String> scopes, LiveAuthListener listener)
java.lang.Boolean	loginSilent(java.lang.Iterable<java.lang.String> scopes, java.lang.Object userState, LiveAuthListener listener) Attempts to log in a user using multiple non-interactive approaches.
java.lang.Boolean	loginSilent(LiveAuthListener listener)
java.lang.Boolean	loginSilent(java.lang.Object userState, LiveAuthListener listener)
void	logout(LiveAuthListener listener) Logs out the given user.
void	logout(java.lang.Object userState, LiveAuthListener listener) Logs out the given user.

Methods inherited from class java.lang.Object

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

Constructor Detail

LiveAuthClient

public LiveAuthClient(android.content.Context context,
              java.lang.String clientId,
              java.lang.Iterable<java.lang.String> scopes,
              OAuthConfig oAuthConfig)

Constructs a new LiveAuthClient instance and initializes its member variables.

Parameters:

context - Context of the Application used to save any refresh_token.

clientId - The client_id of the Live Connect Application to login to.

scopes - to initialize the LiveConnectSession with. See MSDN Live Connect Reference's Scopes and permissions for a list of scopes and explanations.

LiveAuthClient

public LiveAuthClient(android.content.Context context,
              java.lang.String clientId)

LiveAuthClient

public LiveAuthClient(android.content.Context context,
              java.lang.String clientId,
              java.lang.Iterable<java.lang.String> scopes)

Method Detail

getClientId

public java.lang.String getClientId()

Returns:

the client_id of the Live Connect application.

login

public void login(android.app.Activity activity,
         LiveAuthListener listener)

login

public void login(android.app.Activity activity,
         java.lang.Iterable<java.lang.String> scopes,
         LiveAuthListener listener)

login

public void login(android.app.Activity activity,
         java.lang.Iterable<java.lang.String> scopes,
         java.lang.Object userState,
         LiveAuthListener listener)

login

public void login(android.app.Activity activity,
         java.lang.Iterable<java.lang.String> scopes,
         java.lang.Object userState,
         java.lang.String loginHint,
         LiveAuthListener listener)

Logs in an user with the given scopes and additional saved state. login displays a Dialog that will prompt the user for a username and password, and ask for consent to use the given scopes. A LiveConnectSession will be returned by calling LiveAuthListener.onAuthComplete(LiveStatus, LiveConnectSession, Object). Otherwise, the LiveAuthListener.onAuthError(LiveAuthException, Object) will be called. These methods will be called on the main/UI thread.

Parameters:

activity - Activity instance to display the Login dialog on

scopes - to initialize the LiveConnectSession with. See MSDN Live Connect Reference's Scopes and permissions for a list of scopes and explanations. Scopes specified here override scopes specified in the constructor.

userState - arbitrary object that is used to determine the caller of the method.

loginHint - the hint for the sign in experience to show the username pre-filled out

listener - called on either completion or error during the login process.

Throws:

java.lang.IllegalStateException - if there is a pending login request.

loginSilent

public java.lang.Boolean loginSilent(LiveAuthListener listener)

loginSilent

public java.lang.Boolean loginSilent(java.lang.Iterable<java.lang.String> scopes,
                            LiveAuthListener listener)

loginSilent

public java.lang.Boolean loginSilent(java.lang.Object userState,
                            LiveAuthListener listener)

loginSilent

public java.lang.Boolean loginSilent(java.lang.Iterable<java.lang.String> scopes,
                            java.lang.Object userState,
                            LiveAuthListener listener)

Attempts to log in a user using multiple non-interactive approaches. A LiveConnectSession will be returned by calling LiveAuthListener.onAuthComplete(LiveStatus, LiveConnectSession, Object). Otherwise, the LiveAuthListener.onAuthError(LiveAuthException, Object) will be called. These methods will be called on the main/UI thread.

Parameters:

scopes - list of scopes which will override scopes from constructor

userState - state object that is pass to listener on completion.

listener - called on either completion or error during the login process.

Returns:

false == silent login failed, interactive login required. true == silent login is continuing on the background thread the listener will be called back when it has completed.

logout

public void logout(LiveAuthListener listener)

Logs out the given user. Also, this method clears the previously created LiveConnectSession. LiveAuthListener.onAuthComplete(LiveStatus, LiveConnectSession, Object) will be called on completion. Otherwise, LiveAuthListener.onAuthError(LiveAuthException, Object) will be called.

Parameters:

listener - called on either completion or error during the logout process.

logout

public void logout(java.lang.Object userState,
          LiveAuthListener listener)

Logs out the given user. Also, this method clears the previously created LiveConnectSession. LiveAuthListener.onAuthComplete(LiveStatus, LiveConnectSession, Object) will be called on completion. Otherwise, LiveAuthListener.onAuthError(LiveAuthException, Object) will be called.

Parameters:

userState - arbitrary object that is used to determine the caller of the method.

listener - called on either completion or error during the logout process.

getSession

public LiveConnectSession getSession()

Returns:

The LiveConnectSession instance that this LiveAuthClient created.