BrowserCustomizationOptions Class

  • Reference
Package:
com.azure.identity
Maven Artifact:
com.azure:azure-identity:1.12.0
  • java.lang.Object
    • com.azure.identity.BrowserCustomizationOptions

public class BrowserCustomizationOptions

Represent Options to customize browser view.

Constructor Summary

Constructor Description
BrowserCustomizationOptions()

Creates an instance of BrowserCustomizationOptions.

Method Summary

Modifier and Type Method and Description
String getErrorMessage()

Get the configured message which the browser will show to the user when the user finishes authenticating, but an error occurred.
String getSuccessMessage()

Get the configured message which the browser will show to the user when the user finishes authenticating successfully.
BrowserCustomizationOptions setErrorMessage(String errorMessage)

Configure the property to set error message which the browser will show to the user upon failed to acquire an access token.
BrowserCustomizationOptions setSuccessMessage(String successMessage)

Configures the property to set the success message which the browser will show to the user upon successful authentication.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

BrowserCustomizationOptions

public BrowserCustomizationOptions()

Creates an instance of BrowserCustomizationOptions.

Method Details

getErrorMessage

public String getErrorMessage()

Get the configured message which the browser will show to the user when the user finishes authenticating, but an error occurred.

Returns:

the string message.

getSuccessMessage

public String getSuccessMessage()

Get the configured message which the browser will show to the user when the user finishes authenticating successfully.

Returns:

the string message.

setErrorMessage

public BrowserCustomizationOptions setErrorMessage(String errorMessage)

Configure the property to set error message which the browser will show to the user upon failed to acquire an access token. You can use a string format e.g. "An error has occurred: {0} details: {1}.", the details will be populated by the library.

Parameters:

errorMessage - the message to display when user finishes authenticating, but an error occurred.

Returns:

the updated options.

setSuccessMessage

public BrowserCustomizationOptions setSuccessMessage(String successMessage)

Configures the property to set the success message which the browser will show to the user upon successful authentication.

Parameters:

successMessage - the message to display when user finishes authenticating.

Returns:

the updated options.

Applies to