com.microsoft.identity.client

Class AcquireTokenParameters

java.lang.Object

com.microsoft.identity.client.TokenParameters

com.microsoft.identity.client.AcquireTokenParameters

Direct Known Subclasses:

IntuneAcquireTokenParameters

public class AcquireTokenParameters
extends TokenParameters

Encapsulates the parameters passed to the acquireToken methods of PublicClientApplication

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AcquireTokenParameters.Builder

Constructor Summary

Constructors

Constructor and Description
AcquireTokenParameters(AcquireTokenParameters.Builder builder)

Method Summary

Modifier and Type	Method and Description
android.app.Activity	getActivity() Non-null Activity that will be used as the parent activity for launching the com.microsoft.identity.common.internal.providers.oauth2.AuthorizationActivity
AuthenticationCallback	getCallback() The Non-null AuthenticationCallback to receive the result back.
java.util.List<android.util.Pair<java.lang.String,java.lang.String>>	getExtraQueryStringParameters() If you've been instructed to pass additional query string parameters to the authorization endpoint.
java.util.List<java.lang.String>	getExtraScopesToConsent() These are additional scopes that you would like the user to authorize the use of, while getting consent for the first set of scopes
Fragment	getFragment() Optional Fragment that will be replaced by com.microsoft.identity.common.internal.providers.oauth2.AuthorizationFragment
java.lang.String	getLoginHint() Optional.
Prompt	getPrompt() Controls the value of the prompt parameter sent along with the authorization request.

Methods inherited from class com.microsoft.identity.client.TokenParameters

getAccount, getAccountRecord, getAuthenticationScheme, getAuthority, getClaimsRequest, getCorrelationId, getScopes

Methods inherited from class java.lang.Object

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

Constructor Detail

AcquireTokenParameters

public AcquireTokenParameters(AcquireTokenParameters.Builder builder)

Method Detail

getActivity

public android.app.Activity getActivity()

Non-null Activity that will be used as the parent activity for launching the com.microsoft.identity.common.internal.providers.oauth2.AuthorizationActivity

getFragment

public Fragment getFragment()

Optional Fragment that will be replaced by com.microsoft.identity.common.internal.providers.oauth2.AuthorizationFragment

getLoginHint

public java.lang.String getLoginHint()

Optional. Gets the login hint sent along with the authorization request.

Returns:

getPrompt

public Prompt getPrompt()

Controls the value of the prompt parameter sent along with the authorization request.

Returns:

getExtraScopesToConsent

public java.util.List<java.lang.String> getExtraScopesToConsent()

These are additional scopes that you would like the user to authorize the use of, while getting consent for the first set of scopes

Returns:

getExtraQueryStringParameters

public java.util.List<android.util.Pair<java.lang.String,java.lang.String>> getExtraQueryStringParameters()

If you've been instructed to pass additional query string parameters to the authorization endpoint. You can get these here. Otherwise... would recommend not touching.

Returns:

getCallback

public AuthenticationCallback getCallback()

The Non-null AuthenticationCallback to receive the result back. 1) If user cancels the flow by pressing the device back button, the result will be sent back via AuthenticationCallback.onCancel(). 2) If the sdk successfully receives the token back, result will be sent back via SilentAuthenticationCallback.onSuccess(IAuthenticationResult) 3) All the other errors will be sent back via SilentAuthenticationCallback.onError(com.microsoft.identity.client.exception.MsalException).

Returns: