InteractiveRequestParameters.InteractiveRequestParametersBuilder (msal4j 1.20.1 API)

java.lang.Object
- com.microsoft.aad.msal4j.InteractiveRequestParameters.InteractiveRequestParametersBuilder

Enclosing class:: InteractiveRequestParameters

public static class InteractiveRequestParameters.InteractiveRequestParametersBuilder
extends Object

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`InteractiveRequestParameters`	`build()`
`InteractiveRequestParameters.InteractiveRequestParametersBuilder`	`claims(ClaimsRequest claims)` Claims to be requested through the OIDC claims request parameter, allowing requests for standard and custom claims
`InteractiveRequestParameters.InteractiveRequestParametersBuilder`	`claimsChallenge(String claimsChallenge)` Used when a token request fails and the response has a challenge string
`InteractiveRequestParameters.InteractiveRequestParametersBuilder`	`domainHint(String domainHint)` Provides a hint about the tenant or domain that the user should use to sign in.
`InteractiveRequestParameters.InteractiveRequestParametersBuilder`	`extraHttpHeaders(Map<String,String> extraHttpHeaders)` Adds additional headers to the token request
`InteractiveRequestParameters.InteractiveRequestParametersBuilder`	`extraQueryParameters(Map<String,String> extraQueryParameters)` Adds additional query parameters to the token request
`InteractiveRequestParameters.InteractiveRequestParametersBuilder`	`httpPollingTimeoutInSeconds(int httpPollingTimeoutInSeconds)` The amount of time in seconds that the library will wait for an authentication result.
`InteractiveRequestParameters.InteractiveRequestParametersBuilder`	`instanceAware(boolean instanceAware)` If set to true, the authorization result will contain the authority for the user's home cloud, and this authority will be used for the token request instead of the authority set in the application.
`InteractiveRequestParameters.InteractiveRequestParametersBuilder`	`loginHint(String loginHint)` Can be used to pre-fill the username/email address field of the sign-in page for the user, if you know the username/email address ahead of time.
`InteractiveRequestParameters.InteractiveRequestParametersBuilder`	`prompt(Prompt prompt)` Indicate the type of user interaction that is required.
`InteractiveRequestParameters.InteractiveRequestParametersBuilder`	`proofOfPossession(HttpMethod httpMethod, URI uri, String nonce)` Sets the PopParameters for this request, allowing the request to retrieve proof-of-possession tokens rather than bearer tokens
`InteractiveRequestParameters.InteractiveRequestParametersBuilder`	`redirectUri(URI redirectUri)` Redirect URI where MSAL will listen to for the authorization code returned by Azure AD.
`InteractiveRequestParameters.InteractiveRequestParametersBuilder`	`scopes(Set<String> scopes)` Scopes that the application is requesting access to and the user will consent to.
`InteractiveRequestParameters.InteractiveRequestParametersBuilder`	`systemBrowserOptions(SystemBrowserOptions systemBrowserOptions)` Sets `SystemBrowserOptions` to be used by the PublicClientApplication
`InteractiveRequestParameters.InteractiveRequestParametersBuilder`	`tenant(String tenant)` Overrides the tenant value in the authority URL for this request
`String`	`toString()`
`InteractiveRequestParameters.InteractiveRequestParametersBuilder`	`windowHandle(long windowHandle)` The parent window handle used to open UI elements with the correct parent

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Method Detail
  - proofOfPossession
```
public InteractiveRequestParameters.InteractiveRequestParametersBuilder proofOfPossession(HttpMethod httpMethod,
                                                                                          URI uri,
                                                                                          String nonce)
```
    Sets the PopParameters for this request, allowing the request to retrieve proof-of-possession tokens rather than bearer tokens
    For more information, see PopParameters and https://aka.ms/msal4j-pop
    
    Parameters:
    
    httpMethod - a valid HTTP method, such as "GET" or "POST"
    
    uri - the URI on the downstream protected API which the application is trying to access, e.g. https://graph.microsoft.com/beta/me/profile
    
    nonce - a string obtained by calling the resource (e.g. Microsoft Graph) un-authenticated and parsing the WWW-Authenticate header associated with pop authentication scheme and extracting the nonce parameter, or, on subsequent calls, by parsing the Autheticate-Info header and extracting the nextnonce parameter.
  - redirectUri
```
public InteractiveRequestParameters.InteractiveRequestParametersBuilder redirectUri(URI redirectUri)
```
    Redirect URI where MSAL will listen to for the authorization code returned by Azure AD. Should be a loopback address with a port specified (for example, http://localhost:3671). If no port is specified, MSAL will find an open port. For more information, see https://aka.ms/msal4j-interactive-request.
    Cannot be null.
  - claims
```
public InteractiveRequestParameters.InteractiveRequestParametersBuilder claims(ClaimsRequest claims)
```
    Claims to be requested through the OIDC claims request parameter, allowing requests for standard and custom claims
  - scopes
```
public InteractiveRequestParameters.InteractiveRequestParametersBuilder scopes(Set<String> scopes)
```
    Scopes that the application is requesting access to and the user will consent to.
  - prompt
```
public InteractiveRequestParameters.InteractiveRequestParametersBuilder prompt(Prompt prompt)
```
    Indicate the type of user interaction that is required.
  - loginHint
```
public InteractiveRequestParameters.InteractiveRequestParametersBuilder loginHint(String loginHint)
```
    Can be used to pre-fill the username/email address field of the sign-in page for the user, if you know the username/email address ahead of time. Often apps use this parameter during re-authentication, having already extracted the username from a previous sign-in using the preferred_username claim.
  - domainHint
```
public InteractiveRequestParameters.InteractiveRequestParametersBuilder domainHint(String domainHint)
```
    Provides a hint about the tenant or domain that the user should use to sign in. The value of the domain hint is a registered domain for the tenant.
  - systemBrowserOptions
```
public InteractiveRequestParameters.InteractiveRequestParametersBuilder systemBrowserOptions(SystemBrowserOptions systemBrowserOptions)
```
    Sets SystemBrowserOptions to be used by the PublicClientApplication
  - claimsChallenge
```
public InteractiveRequestParameters.InteractiveRequestParametersBuilder claimsChallenge(String claimsChallenge)
```
    Used when a token request fails and the response has a challenge string
  - extraHttpHeaders
```
public InteractiveRequestParameters.InteractiveRequestParametersBuilder extraHttpHeaders(Map<String,String> extraHttpHeaders)
```
    Adds additional headers to the token request
  - extraQueryParameters
```
public InteractiveRequestParameters.InteractiveRequestParametersBuilder extraQueryParameters(Map<String,String> extraQueryParameters)
```
    Adds additional query parameters to the token request
  - tenant
```
public InteractiveRequestParameters.InteractiveRequestParametersBuilder tenant(String tenant)
```
    Overrides the tenant value in the authority URL for this request
  - httpPollingTimeoutInSeconds
```
public InteractiveRequestParameters.InteractiveRequestParametersBuilder httpPollingTimeoutInSeconds(int httpPollingTimeoutInSeconds)
```
    The amount of time in seconds that the library will wait for an authentication result. 120 seconds is the default timeout.
    If this timeout is set to 0 or less it will be ignored, and the library will use a 1-second timeout instead
  - instanceAware
```
public InteractiveRequestParameters.InteractiveRequestParametersBuilder instanceAware(boolean instanceAware)
```
    If set to true, the authorization result will contain the authority for the user's home cloud, and this authority will be used for the token request instead of the authority set in the application.
  - windowHandle
```
public InteractiveRequestParameters.InteractiveRequestParametersBuilder windowHandle(long windowHandle)
```
    The parent window handle used to open UI elements with the correct parent
    For browser scenarios and Windows console applications, this value should not need to be set
    For Windows console applications, MSAL Java will attempt to discover the console's window handle if this parameter is not set
    For scenarios where MSAL Java is responsible for opening UI elements (such as when using MSALRuntime), this parameter is required and an exception will be thrown if not set
  - build
```
public InteractiveRequestParameters build()
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class InteractiveRequestParameters.InteractiveRequestParametersBuilder

Method Summary

Methods inherited from class java.lang.Object

Method Detail

proofOfPossession

redirectUri

claims

scopes

prompt

loginHint

domainHint

systemBrowserOptions

claimsChallenge

extraHttpHeaders

extraQueryParameters

tenant

httpPollingTimeoutInSeconds

instanceAware

windowHandle

build

toString