azure-docs-sdk-java/docs-ref-autogen/com.azure.identity.BrowserC...

86 строки
6.1 KiB
YAML

### YamlMime:JavaType
uid: "com.azure.identity.BrowserCustomizationOptions"
fullName: "com.azure.identity.BrowserCustomizationOptions"
name: "BrowserCustomizationOptions"
nameWithType: "BrowserCustomizationOptions"
summary: "Represent Options to customize browser view."
inheritances:
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
inheritedClassMethods:
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
methodsRef:
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
syntax: "public class **BrowserCustomizationOptions**"
constructors:
- uid: "com.azure.identity.BrowserCustomizationOptions.BrowserCustomizationOptions()"
fullName: "com.azure.identity.BrowserCustomizationOptions.BrowserCustomizationOptions()"
name: "BrowserCustomizationOptions()"
nameWithType: "BrowserCustomizationOptions.BrowserCustomizationOptions()"
summary: "Creates an instance of Browser<wbr>Customization<wbr>Options."
syntax: "public BrowserCustomizationOptions()"
desc: "Creates an instance of BrowserCustomizationOptions."
methods:
- uid: "com.azure.identity.BrowserCustomizationOptions.getErrorMessage()"
fullName: "com.azure.identity.BrowserCustomizationOptions.getErrorMessage()"
name: "getErrorMessage()"
nameWithType: "BrowserCustomizationOptions.getErrorMessage()"
summary: "Get the configured message which the browser will show to the user when the user finishes authenticating, but an error occurred."
syntax: "public String getErrorMessage()"
desc: "Get the configured message which the browser will show to the user when the user finishes authenticating, but an error occurred."
returns:
description: "the string message."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.identity.BrowserCustomizationOptions.getSuccessMessage()"
fullName: "com.azure.identity.BrowserCustomizationOptions.getSuccessMessage()"
name: "getSuccessMessage()"
nameWithType: "BrowserCustomizationOptions.getSuccessMessage()"
summary: "Get the configured message which the browser will show to the user when the user finishes authenticating successfully."
syntax: "public String getSuccessMessage()"
desc: "Get the configured message which the browser will show to the user when the user finishes authenticating successfully."
returns:
description: "the string message."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.identity.BrowserCustomizationOptions.setErrorMessage(java.lang.String)"
fullName: "com.azure.identity.BrowserCustomizationOptions.setErrorMessage(String errorMessage)"
name: "setErrorMessage(String errorMessage)"
nameWithType: "BrowserCustomizationOptions.setErrorMessage(String errorMessage)"
summary: "Configure the property to set error message which the browser will show to the user upon failed to acquire an access token."
parameters:
- description: "the message to display when user finishes authenticating, but an error occurred."
name: "errorMessage"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public BrowserCustomizationOptions setErrorMessage(String errorMessage)"
desc: "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."
returns:
description: "the updated options."
type: "<xref href=\"com.azure.identity.BrowserCustomizationOptions?alt=com.azure.identity.BrowserCustomizationOptions&text=BrowserCustomizationOptions\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.identity.BrowserCustomizationOptions.setSuccessMessage(java.lang.String)"
fullName: "com.azure.identity.BrowserCustomizationOptions.setSuccessMessage(String successMessage)"
name: "setSuccessMessage(String successMessage)"
nameWithType: "BrowserCustomizationOptions.setSuccessMessage(String successMessage)"
summary: "Configures the property to set the success message which the browser will show to the user upon successful authentication."
parameters:
- description: "the message to display when user finishes authenticating."
name: "successMessage"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public BrowserCustomizationOptions setSuccessMessage(String successMessage)"
desc: "Configures the property to set the success message which the browser will show to the user upon successful authentication."
returns:
description: "the updated options."
type: "<xref href=\"com.azure.identity.BrowserCustomizationOptions?alt=com.azure.identity.BrowserCustomizationOptions&text=BrowserCustomizationOptions\" data-throw-if-not-resolved=\"False\" />"
type: "class"
desc: "Represent Options to customize browser view."
metadata: {}
package: "com.azure.identity"
artifact: com.azure:azure-identity:1.14.1