214 строки
28 KiB
YAML
214 строки
28 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.azure.communication.chat.ChatClientBuilder"
|
|
fullName: "com.azure.communication.chat.ChatClientBuilder"
|
|
name: "ChatClientBuilder"
|
|
nameWithType: "ChatClientBuilder"
|
|
summary: "Builder for creating clients of Azure Communication Service Chat"
|
|
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 final class **ChatClientBuilder**</br> implements <xref href=\"com.azure.core.client.traits.ConfigurationTrait?alt=com.azure.core.client.traits.ConfigurationTrait&text=ConfigurationTrait\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.communication.chat.ChatClientBuilder?alt=com.azure.communication.chat.ChatClientBuilder&text=ChatClientBuilder\" data-throw-if-not-resolved=\"False\" />>, <xref href=\"com.azure.core.client.traits.EndpointTrait?alt=com.azure.core.client.traits.EndpointTrait&text=EndpointTrait\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.communication.chat.ChatClientBuilder?alt=com.azure.communication.chat.ChatClientBuilder&text=ChatClientBuilder\" data-throw-if-not-resolved=\"False\" />>, <xref href=\"com.azure.core.client.traits.HttpTrait?alt=com.azure.core.client.traits.HttpTrait&text=HttpTrait\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.communication.chat.ChatClientBuilder?alt=com.azure.communication.chat.ChatClientBuilder&text=ChatClientBuilder\" data-throw-if-not-resolved=\"False\" />>"
|
|
constructors:
|
|
- uid: "com.azure.communication.chat.ChatClientBuilder.ChatClientBuilder()"
|
|
fullName: "com.azure.communication.chat.ChatClientBuilder.ChatClientBuilder()"
|
|
name: "ChatClientBuilder()"
|
|
nameWithType: "ChatClientBuilder.ChatClientBuilder()"
|
|
syntax: "public ChatClientBuilder()"
|
|
methods:
|
|
- uid: "com.azure.communication.chat.ChatClientBuilder.addPolicy(com.azure.core.http.policy.HttpPipelinePolicy)"
|
|
fullName: "com.azure.communication.chat.ChatClientBuilder.addPolicy(HttpPipelinePolicy customPolicy)"
|
|
name: "addPolicy(HttpPipelinePolicy customPolicy)"
|
|
nameWithType: "ChatClientBuilder.addPolicy(HttpPipelinePolicy customPolicy)"
|
|
summary: "Adds a <xref uid=\"com.azure.core.http.policy.HttpPipelinePolicy\" data-throw-if-not-resolved=\"false\" data-raw-source=\"pipeline policy\"></xref> to apply on each request sent."
|
|
parameters:
|
|
- description: "A <xref uid=\"com.azure.core.http.policy.HttpPipelinePolicy\" data-throw-if-not-resolved=\"false\" data-raw-source=\"pipeline policy\"></xref>."
|
|
name: "customPolicy"
|
|
type: "<xref href=\"com.azure.core.http.policy.HttpPipelinePolicy?alt=com.azure.core.http.policy.HttpPipelinePolicy&text=HttpPipelinePolicy\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public ChatClientBuilder addPolicy(HttpPipelinePolicy customPolicy)"
|
|
desc: "Adds a <xref uid=\"com.azure.core.http.policy.HttpPipelinePolicy\" data-throw-if-not-resolved=\"false\" data-raw-source=\"pipeline policy\"></xref> to apply on each request sent.\n\n**Note:** It is important to understand the precedence order of the HttpTrait APIs. In particular, if a <xref uid=\"com.azure.core.http.HttpPipeline\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpPipeline\"></xref> is specified, this takes precedence over all other APIs in the trait, and they will be ignored. If no <xref uid=\"com.azure.core.http.HttpPipeline\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpPipeline\"></xref> is specified, a HTTP pipeline will be constructed internally based on the settings provided to this trait. Additionally, there may be other APIs in types that implement this trait that are also ignored if an <xref uid=\"com.azure.core.http.HttpPipeline\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpPipeline\"></xref> is specified, so please be sure to refer to the documentation of types that implement this trait to understand the full set of implications."
|
|
returns:
|
|
description: "the updated ChatClientBuilder object"
|
|
type: "<xref href=\"com.azure.communication.chat.ChatClientBuilder?alt=com.azure.communication.chat.ChatClientBuilder&text=ChatClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.communication.chat.ChatClientBuilder.buildAsyncClient()"
|
|
fullName: "com.azure.communication.chat.ChatClientBuilder.buildAsyncClient()"
|
|
name: "buildAsyncClient()"
|
|
nameWithType: "ChatClientBuilder.buildAsyncClient()"
|
|
summary: "Create asynchronous chat client applying Communication<wbr>Token<wbr>Credential, User<wbr>Agent<wbr>Policy, Retry<wbr>Policy, and Cookie<wbr>Policy."
|
|
syntax: "public ChatAsyncClient buildAsyncClient()"
|
|
desc: "Create asynchronous chat client applying CommunicationTokenCredential, UserAgentPolicy, RetryPolicy, and CookiePolicy. Additional HttpPolicies specified by additionalPolicies will be applied after them"
|
|
returns:
|
|
description: "ChatAsyncClient instance"
|
|
type: "<xref href=\"com.azure.communication.chat.ChatAsyncClient?alt=com.azure.communication.chat.ChatAsyncClient&text=ChatAsyncClient\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.communication.chat.ChatClientBuilder.buildClient()"
|
|
fullName: "com.azure.communication.chat.ChatClientBuilder.buildClient()"
|
|
name: "buildClient()"
|
|
nameWithType: "ChatClientBuilder.buildClient()"
|
|
summary: "Create synchronous chat client applying Communication<wbr>Token<wbr>Credential, User<wbr>Agent<wbr>Policy, Retry<wbr>Policy, and Cookie<wbr>Policy."
|
|
syntax: "public ChatClient buildClient()"
|
|
desc: "Create synchronous chat client applying CommunicationTokenCredential, UserAgentPolicy, RetryPolicy, and CookiePolicy. Additional HttpPolicies specified by additionalPolicies will be applied after them"
|
|
returns:
|
|
description: "ChatClient instance"
|
|
type: "<xref href=\"com.azure.communication.chat.ChatClient?alt=com.azure.communication.chat.ChatClient&text=ChatClient\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.communication.chat.ChatClientBuilder.clientOptions(com.azure.core.util.ClientOptions)"
|
|
fullName: "com.azure.communication.chat.ChatClientBuilder.clientOptions(ClientOptions clientOptions)"
|
|
name: "clientOptions(ClientOptions clientOptions)"
|
|
nameWithType: "ChatClientBuilder.clientOptions(ClientOptions clientOptions)"
|
|
summary: "Allows for setting common properties such as application ID, headers, proxy configuration, etc."
|
|
parameters:
|
|
- description: "A configured instance of <xref uid=\"\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpClientOptions\"></xref>."
|
|
name: "clientOptions"
|
|
type: "<xref href=\"com.azure.core.util.ClientOptions?alt=com.azure.core.util.ClientOptions&text=ClientOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public ChatClientBuilder clientOptions(ClientOptions clientOptions)"
|
|
desc: "Allows for setting common properties such as application ID, headers, proxy configuration, etc. Note that it is recommended that this method be called with an instance of the <xref uid=\"\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpClientOptions\"></xref> class (a subclass of the <xref uid=\"com.azure.core.util.ClientOptions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ClientOptions\"></xref> base class). The HttpClientOptions subclass provides more configuration options suitable for HTTP clients, which is applicable for any class that implements this HttpTrait interface.\n\n**Note:** It is important to understand the precedence order of the HttpTrait APIs. In particular, if a <xref uid=\"com.azure.core.http.HttpPipeline\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpPipeline\"></xref> is specified, this takes precedence over all other APIs in the trait, and they will be ignored. If no <xref uid=\"com.azure.core.http.HttpPipeline\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpPipeline\"></xref> is specified, a HTTP pipeline will be constructed internally based on the settings provided to this trait. Additionally, there may be other APIs in types that implement this trait that are also ignored if an <xref uid=\"com.azure.core.http.HttpPipeline\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpPipeline\"></xref> is specified, so please be sure to refer to the documentation of types that implement this trait to understand the full set of implications."
|
|
returns:
|
|
description: "The updated ChatClientBuilder object."
|
|
type: "<xref href=\"com.azure.communication.chat.ChatClientBuilder?alt=com.azure.communication.chat.ChatClientBuilder&text=ChatClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.communication.chat.ChatClientBuilder.configuration(com.azure.core.util.Configuration)"
|
|
fullName: "com.azure.communication.chat.ChatClientBuilder.configuration(Configuration configuration)"
|
|
name: "configuration(Configuration configuration)"
|
|
nameWithType: "ChatClientBuilder.configuration(Configuration configuration)"
|
|
summary: "Sets the configuration object used to retrieve environment configuration values during building of the client."
|
|
parameters:
|
|
- description: "Configuration store used to retrieve environment configurations."
|
|
name: "configuration"
|
|
type: "<xref href=\"com.azure.core.util.Configuration?alt=com.azure.core.util.Configuration&text=Configuration\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public ChatClientBuilder configuration(Configuration configuration)"
|
|
desc: "Sets the configuration object used to retrieve environment configuration values during building of the client."
|
|
returns:
|
|
description: "the updated ChatClientBuilder object"
|
|
type: "<xref href=\"com.azure.communication.chat.ChatClientBuilder?alt=com.azure.communication.chat.ChatClientBuilder&text=ChatClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.communication.chat.ChatClientBuilder.credential(com.azure.communication.common.CommunicationTokenCredential)"
|
|
fullName: "com.azure.communication.chat.ChatClientBuilder.credential(CommunicationTokenCredential communicationTokenCredential)"
|
|
name: "credential(CommunicationTokenCredential communicationTokenCredential)"
|
|
nameWithType: "ChatClientBuilder.credential(CommunicationTokenCredential communicationTokenCredential)"
|
|
summary: "Set a token credential for authorization"
|
|
parameters:
|
|
- description: "valid token credential as a string"
|
|
name: "communicationTokenCredential"
|
|
type: "<xref href=\"com.azure.communication.common.CommunicationTokenCredential?alt=com.azure.communication.common.CommunicationTokenCredential&text=CommunicationTokenCredential\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public ChatClientBuilder credential(CommunicationTokenCredential communicationTokenCredential)"
|
|
desc: "Set a token credential for authorization"
|
|
returns:
|
|
description: "the updated ChatClientBuilder object"
|
|
type: "<xref href=\"com.azure.communication.chat.ChatClientBuilder?alt=com.azure.communication.chat.ChatClientBuilder&text=ChatClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.communication.chat.ChatClientBuilder.endpoint(java.lang.String)"
|
|
fullName: "com.azure.communication.chat.ChatClientBuilder.endpoint(String endpoint)"
|
|
name: "endpoint(String endpoint)"
|
|
nameWithType: "ChatClientBuilder.endpoint(String endpoint)"
|
|
summary: "Set endpoint of the service"
|
|
parameters:
|
|
- description: "url of the service"
|
|
name: "endpoint"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public ChatClientBuilder endpoint(String endpoint)"
|
|
desc: "Set endpoint of the service"
|
|
returns:
|
|
description: "the updated ChatClientBuilder object"
|
|
type: "<xref href=\"com.azure.communication.chat.ChatClientBuilder?alt=com.azure.communication.chat.ChatClientBuilder&text=ChatClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.communication.chat.ChatClientBuilder.httpClient(com.azure.core.http.HttpClient)"
|
|
fullName: "com.azure.communication.chat.ChatClientBuilder.httpClient(HttpClient httpClient)"
|
|
name: "httpClient(HttpClient httpClient)"
|
|
nameWithType: "ChatClientBuilder.httpClient(HttpClient httpClient)"
|
|
summary: "Sets the <xref uid=\"com.azure.core.http.HttpClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpClient\"></xref> to use for sending and receiving requests to and from the service."
|
|
parameters:
|
|
- description: "The <xref uid=\"com.azure.core.http.HttpClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpClient\"></xref> to use for requests."
|
|
name: "httpClient"
|
|
type: "<xref href=\"com.azure.core.http.HttpClient?alt=com.azure.core.http.HttpClient&text=HttpClient\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public ChatClientBuilder httpClient(HttpClient httpClient)"
|
|
desc: "Sets the <xref uid=\"com.azure.core.http.HttpClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpClient\"></xref> to use for sending and receiving requests to and from the service.\n\n**Note:** It is important to understand the precedence order of the HttpTrait APIs. In particular, if a <xref uid=\"com.azure.core.http.HttpPipeline\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpPipeline\"></xref> is specified, this takes precedence over all other APIs in the trait, and they will be ignored. If no <xref uid=\"com.azure.core.http.HttpPipeline\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpPipeline\"></xref> is specified, a HTTP pipeline will be constructed internally based on the settings provided to this trait. Additionally, there may be other APIs in types that implement this trait that are also ignored if an <xref uid=\"com.azure.core.http.HttpPipeline\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpPipeline\"></xref> is specified, so please be sure to refer to the documentation of types that implement this trait to understand the full set of implications."
|
|
returns:
|
|
description: "the updated ChatClientBuilder object"
|
|
type: "<xref href=\"com.azure.communication.chat.ChatClientBuilder?alt=com.azure.communication.chat.ChatClientBuilder&text=ChatClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.communication.chat.ChatClientBuilder.httpLogOptions(com.azure.core.http.policy.HttpLogOptions)"
|
|
fullName: "com.azure.communication.chat.ChatClientBuilder.httpLogOptions(HttpLogOptions logOptions)"
|
|
name: "httpLogOptions(HttpLogOptions logOptions)"
|
|
nameWithType: "ChatClientBuilder.httpLogOptions(HttpLogOptions logOptions)"
|
|
summary: "Sets the <xref uid=\"com.azure.core.http.policy.HttpLogOptions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"logging configuration\"></xref> to use when sending and receiving requests to and from the service."
|
|
parameters:
|
|
- description: "The <xref uid=\"com.azure.core.http.policy.HttpLogOptions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"logging configuration\"></xref> to use when sending and receiving requests to\n and from the service."
|
|
name: "logOptions"
|
|
type: "<xref href=\"com.azure.core.http.policy.HttpLogOptions?alt=com.azure.core.http.policy.HttpLogOptions&text=HttpLogOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public ChatClientBuilder httpLogOptions(HttpLogOptions logOptions)"
|
|
desc: "Sets the <xref uid=\"com.azure.core.http.policy.HttpLogOptions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"logging configuration\"></xref> to use when sending and receiving requests to and from the service. If a `logLevel` is not provided, default value of <xref uid=\"\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpLogDetailLevel#NONE\"></xref> is set.\n\n**Note:** It is important to understand the precedence order of the HttpTrait APIs. In particular, if a <xref uid=\"com.azure.core.http.HttpPipeline\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpPipeline\"></xref> is specified, this takes precedence over all other APIs in the trait, and they will be ignored. If no <xref uid=\"com.azure.core.http.HttpPipeline\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpPipeline\"></xref> is specified, a HTTP pipeline will be constructed internally based on the settings provided to this trait. Additionally, there may be other APIs in types that implement this trait that are also ignored if an <xref uid=\"com.azure.core.http.HttpPipeline\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpPipeline\"></xref> is specified, so please be sure to refer to the documentation of types that implement this trait to understand the full set of implications."
|
|
returns:
|
|
description: "the updated ChatClientBuilder object"
|
|
type: "<xref href=\"com.azure.communication.chat.ChatClientBuilder?alt=com.azure.communication.chat.ChatClientBuilder&text=ChatClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.communication.chat.ChatClientBuilder.pipeline(com.azure.core.http.HttpPipeline)"
|
|
fullName: "com.azure.communication.chat.ChatClientBuilder.pipeline(HttpPipeline httpPipeline)"
|
|
name: "pipeline(HttpPipeline httpPipeline)"
|
|
nameWithType: "ChatClientBuilder.pipeline(HttpPipeline httpPipeline)"
|
|
summary: "Sets the <xref uid=\"com.azure.core.http.HttpPipeline\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpPipeline\"></xref> to use for the service client."
|
|
parameters:
|
|
- description: "<xref uid=\"com.azure.core.http.HttpPipeline\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpPipeline\"></xref> to use for sending service requests and receiving responses."
|
|
name: "httpPipeline"
|
|
type: "<xref href=\"com.azure.core.http.HttpPipeline?alt=com.azure.core.http.HttpPipeline&text=HttpPipeline\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public ChatClientBuilder pipeline(HttpPipeline httpPipeline)"
|
|
desc: "Sets the <xref uid=\"com.azure.core.http.HttpPipeline\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpPipeline\"></xref> to use for the service client.\n\n**Note:** It is important to understand the precedence order of the HttpTrait APIs. In particular, if a <xref uid=\"com.azure.core.http.HttpPipeline\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpPipeline\"></xref> is specified, this takes precedence over all other APIs in the trait, and they will be ignored. If no <xref uid=\"com.azure.core.http.HttpPipeline\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpPipeline\"></xref> is specified, a HTTP pipeline will be constructed internally based on the settings provided to this trait. Additionally, there may be other APIs in types that implement this trait that are also ignored if an <xref uid=\"com.azure.core.http.HttpPipeline\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpPipeline\"></xref> is specified, so please be sure to refer to the documentation of types that implement this trait to understand the full set of implications.\n\nIf `pipeline` is set, all other settings are ignored, aside from <xref uid=\"com.azure.communication.chat.ChatClientBuilder.endpoint(java.lang.String)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"endpoint\"></xref>."
|
|
returns:
|
|
description: "the updated ChatClientBuilder object"
|
|
type: "<xref href=\"com.azure.communication.chat.ChatClientBuilder?alt=com.azure.communication.chat.ChatClientBuilder&text=ChatClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.communication.chat.ChatClientBuilder.retryOptions(com.azure.core.http.policy.RetryOptions)"
|
|
fullName: "com.azure.communication.chat.ChatClientBuilder.retryOptions(RetryOptions retryOptions)"
|
|
name: "retryOptions(RetryOptions retryOptions)"
|
|
nameWithType: "ChatClientBuilder.retryOptions(RetryOptions retryOptions)"
|
|
summary: "Sets the <xref uid=\"com.azure.core.http.policy.RetryOptions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"RetryOptions\"></xref> for all the requests made through the client."
|
|
parameters:
|
|
- description: "The <xref uid=\"com.azure.core.http.policy.RetryOptions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"RetryOptions\"></xref> to use for all the requests made through the client."
|
|
name: "retryOptions"
|
|
type: "<xref href=\"com.azure.core.http.policy.RetryOptions?alt=com.azure.core.http.policy.RetryOptions&text=RetryOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public ChatClientBuilder retryOptions(RetryOptions retryOptions)"
|
|
desc: "Sets the <xref uid=\"com.azure.core.http.policy.RetryOptions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"RetryOptions\"></xref> for all the requests made through the client.\n\n**Note:** It is important to understand the precedence order of the HttpTrait APIs. In particular, if a <xref uid=\"com.azure.core.http.HttpPipeline\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpPipeline\"></xref> is specified, this takes precedence over all other APIs in the trait, and they will be ignored. If no <xref uid=\"com.azure.core.http.HttpPipeline\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpPipeline\"></xref> is specified, a HTTP pipeline will be constructed internally based on the settings provided to this trait. Additionally, there may be other APIs in types that implement this trait that are also ignored if an <xref uid=\"com.azure.core.http.HttpPipeline\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpPipeline\"></xref> is specified, so please be sure to refer to the documentation of types that implement this trait to understand the full set of implications.\n\nSetting this is mutually exclusive with using <xref uid=\"com.azure.communication.chat.ChatClientBuilder.retryPolicy(com.azure.core.http.policy.RetryPolicy)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#retryPolicy(RetryPolicy)\"></xref>."
|
|
returns:
|
|
description: "The updated ChatClientBuilder object."
|
|
type: "<xref href=\"com.azure.communication.chat.ChatClientBuilder?alt=com.azure.communication.chat.ChatClientBuilder&text=ChatClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.communication.chat.ChatClientBuilder.retryPolicy(com.azure.core.http.policy.RetryPolicy)"
|
|
fullName: "com.azure.communication.chat.ChatClientBuilder.retryPolicy(RetryPolicy retryPolicy)"
|
|
name: "retryPolicy(RetryPolicy retryPolicy)"
|
|
nameWithType: "ChatClientBuilder.retryPolicy(RetryPolicy retryPolicy)"
|
|
summary: "Sets the <xref uid=\"com.azure.core.http.policy.HttpPipelinePolicy\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpPipelinePolicy\"></xref> that will attempt to retry requests when needed."
|
|
parameters:
|
|
- description: "The <xref uid=\"com.azure.core.http.policy.RetryPolicy\" data-throw-if-not-resolved=\"false\" data-raw-source=\"RetryPolicy\"></xref> that will attempt to retry requests when needed."
|
|
name: "retryPolicy"
|
|
type: "<xref href=\"com.azure.core.http.policy.RetryPolicy?alt=com.azure.core.http.policy.RetryPolicy&text=RetryPolicy\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public ChatClientBuilder retryPolicy(RetryPolicy retryPolicy)"
|
|
desc: "Sets the <xref uid=\"com.azure.core.http.policy.HttpPipelinePolicy\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpPipelinePolicy\"></xref> that will attempt to retry requests when needed.\n\nA default retry policy will be supplied if one isn't provided.\n\nSetting this is mutually exclusive with using <xref uid=\"com.azure.communication.chat.ChatClientBuilder.retryOptions(com.azure.core.http.policy.RetryOptions)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#retryOptions(RetryOptions)\"></xref>."
|
|
returns:
|
|
description: "The updated ChatClientBuilder object."
|
|
type: "<xref href=\"com.azure.communication.chat.ChatClientBuilder?alt=com.azure.communication.chat.ChatClientBuilder&text=ChatClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.communication.chat.ChatClientBuilder.serviceVersion(com.azure.communication.chat.ChatServiceVersion)"
|
|
fullName: "com.azure.communication.chat.ChatClientBuilder.serviceVersion(ChatServiceVersion version)"
|
|
name: "serviceVersion(ChatServiceVersion version)"
|
|
nameWithType: "ChatClientBuilder.serviceVersion(ChatServiceVersion version)"
|
|
summary: "Sets the <xref uid=\"com.azure.communication.chat.ChatServiceVersion\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ChatServiceVersion\"></xref> that is used when making API requests."
|
|
parameters:
|
|
- description: "<xref uid=\"com.azure.communication.chat.ChatServiceVersion\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ChatServiceVersion\"></xref> of the service to be used when making requests."
|
|
name: "version"
|
|
type: "<xref href=\"com.azure.communication.chat.ChatServiceVersion?alt=com.azure.communication.chat.ChatServiceVersion&text=ChatServiceVersion\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public ChatClientBuilder serviceVersion(ChatServiceVersion version)"
|
|
desc: "Sets the <xref uid=\"com.azure.communication.chat.ChatServiceVersion\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ChatServiceVersion\"></xref> that is used when making API requests.\n\nIf a service version is not provided, the service version that will be used will be the latest known service version based on the version of the client library being used. If no service version is specified, updating to a newer version of the client library will have the result of potentially moving to a newer service version.\n\nTargeting a specific service version may also mean that the service will return an error for newer APIs."
|
|
returns:
|
|
description: "the updated ChatClientBuilder object"
|
|
type: "<xref href=\"com.azure.communication.chat.ChatClientBuilder?alt=com.azure.communication.chat.ChatClientBuilder&text=ChatClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
|
type: "class"
|
|
desc: "Builder for creating clients of Azure Communication Service Chat"
|
|
implements:
|
|
- "<xref href=\"com.azure.core.client.traits.ConfigurationTrait?alt=com.azure.core.client.traits.ConfigurationTrait&text=ConfigurationTrait\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.communication.chat.ChatClientBuilder?alt=com.azure.communication.chat.ChatClientBuilder&text=ChatClientBuilder\" data-throw-if-not-resolved=\"False\" />>"
|
|
- "<xref href=\"com.azure.core.client.traits.EndpointTrait?alt=com.azure.core.client.traits.EndpointTrait&text=EndpointTrait\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.communication.chat.ChatClientBuilder?alt=com.azure.communication.chat.ChatClientBuilder&text=ChatClientBuilder\" data-throw-if-not-resolved=\"False\" />>"
|
|
- "<xref href=\"com.azure.core.client.traits.HttpTrait?alt=com.azure.core.client.traits.HttpTrait&text=HttpTrait\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.communication.chat.ChatClientBuilder?alt=com.azure.communication.chat.ChatClientBuilder&text=ChatClientBuilder\" data-throw-if-not-resolved=\"False\" />>"
|
|
metadata: {}
|
|
package: "com.azure.communication.chat"
|
|
artifact: com.azure:azure-communication-chat:1.5.4
|