228 строки
30 KiB
YAML
228 строки
30 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.azure.communication.chat.ChatThreadClientBuilder"
|
|
fullName: "com.azure.communication.chat.ChatThreadClientBuilder"
|
|
name: "ChatThreadClientBuilder"
|
|
nameWithType: "ChatThreadClientBuilder"
|
|
summary: "Builder for creating clients of Azure Communication Service Chat Threads"
|
|
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 **ChatThreadClientBuilder**</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.ChatThreadClientBuilder?alt=com.azure.communication.chat.ChatThreadClientBuilder&text=ChatThreadClientBuilder\" 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.ChatThreadClientBuilder?alt=com.azure.communication.chat.ChatThreadClientBuilder&text=ChatThreadClientBuilder\" 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.ChatThreadClientBuilder?alt=com.azure.communication.chat.ChatThreadClientBuilder&text=ChatThreadClientBuilder\" data-throw-if-not-resolved=\"False\" />>"
|
|
constructors:
|
|
- uid: "com.azure.communication.chat.ChatThreadClientBuilder.ChatThreadClientBuilder()"
|
|
fullName: "com.azure.communication.chat.ChatThreadClientBuilder.ChatThreadClientBuilder()"
|
|
name: "ChatThreadClientBuilder()"
|
|
nameWithType: "ChatThreadClientBuilder.ChatThreadClientBuilder()"
|
|
syntax: "public ChatThreadClientBuilder()"
|
|
methods:
|
|
- uid: "com.azure.communication.chat.ChatThreadClientBuilder.addPolicy(com.azure.core.http.policy.HttpPipelinePolicy)"
|
|
fullName: "com.azure.communication.chat.ChatThreadClientBuilder.addPolicy(HttpPipelinePolicy customPolicy)"
|
|
name: "addPolicy(HttpPipelinePolicy customPolicy)"
|
|
nameWithType: "ChatThreadClientBuilder.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 ChatThreadClientBuilder 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 ChatThreadClientBuilder object"
|
|
type: "<xref href=\"com.azure.communication.chat.ChatThreadClientBuilder?alt=com.azure.communication.chat.ChatThreadClientBuilder&text=ChatThreadClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.communication.chat.ChatThreadClientBuilder.buildAsyncClient()"
|
|
fullName: "com.azure.communication.chat.ChatThreadClientBuilder.buildAsyncClient()"
|
|
name: "buildAsyncClient()"
|
|
nameWithType: "ChatThreadClientBuilder.buildAsyncClient()"
|
|
summary: "Create asynchronous chat thread client applying Communication<wbr>Token<wbr>Credential, User<wbr>Agent<wbr>Policy, Retry<wbr>Policy, and Cookie<wbr>Policy."
|
|
syntax: "public ChatThreadAsyncClient buildAsyncClient()"
|
|
desc: "Create asynchronous chat thread client applying CommunicationTokenCredential, UserAgentPolicy, RetryPolicy, and CookiePolicy. Additional HttpPolicies specified by additionalPolicies will be applied after them"
|
|
returns:
|
|
description: "ChatThreadAsyncClient instance"
|
|
type: "<xref href=\"com.azure.communication.chat.ChatThreadAsyncClient?alt=com.azure.communication.chat.ChatThreadAsyncClient&text=ChatThreadAsyncClient\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.communication.chat.ChatThreadClientBuilder.buildClient()"
|
|
fullName: "com.azure.communication.chat.ChatThreadClientBuilder.buildClient()"
|
|
name: "buildClient()"
|
|
nameWithType: "ChatThreadClientBuilder.buildClient()"
|
|
summary: "Create synchronous chat thread client applying Communication<wbr>Token<wbr>Credential, User<wbr>Agent<wbr>Policy, Retry<wbr>Policy, and Cookie<wbr>Policy."
|
|
syntax: "public ChatThreadClient buildClient()"
|
|
desc: "Create synchronous chat thread client applying CommunicationTokenCredential, UserAgentPolicy, RetryPolicy, and CookiePolicy. Additional HttpPolicies specified by additionalPolicies will be applied after them"
|
|
returns:
|
|
description: "ChatThreadClient instance"
|
|
type: "<xref href=\"com.azure.communication.chat.ChatThreadClient?alt=com.azure.communication.chat.ChatThreadClient&text=ChatThreadClient\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.communication.chat.ChatThreadClientBuilder.chatThreadId(java.lang.String)"
|
|
fullName: "com.azure.communication.chat.ChatThreadClientBuilder.chatThreadId(String chatThreadId)"
|
|
name: "chatThreadId(String chatThreadId)"
|
|
nameWithType: "ChatThreadClientBuilder.chatThreadId(String chatThreadId)"
|
|
summary: "Sets the Chat<wbr>Thread<wbr>Id used to construct a client for this chat thread."
|
|
parameters:
|
|
- description: "The id of the chat thread."
|
|
name: "chatThreadId"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public ChatThreadClientBuilder chatThreadId(String chatThreadId)"
|
|
desc: "Sets the ChatThreadId used to construct a client for this chat thread."
|
|
returns:
|
|
description: "the updated ChatThreadClientBuilder object"
|
|
type: "<xref href=\"com.azure.communication.chat.ChatThreadClientBuilder?alt=com.azure.communication.chat.ChatThreadClientBuilder&text=ChatThreadClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.communication.chat.ChatThreadClientBuilder.clientOptions(com.azure.core.util.ClientOptions)"
|
|
fullName: "com.azure.communication.chat.ChatThreadClientBuilder.clientOptions(ClientOptions clientOptions)"
|
|
name: "clientOptions(ClientOptions clientOptions)"
|
|
nameWithType: "ChatThreadClientBuilder.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 ChatThreadClientBuilder 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 ChatThreadClientBuilder object."
|
|
type: "<xref href=\"com.azure.communication.chat.ChatThreadClientBuilder?alt=com.azure.communication.chat.ChatThreadClientBuilder&text=ChatThreadClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.communication.chat.ChatThreadClientBuilder.configuration(com.azure.core.util.Configuration)"
|
|
fullName: "com.azure.communication.chat.ChatThreadClientBuilder.configuration(Configuration configuration)"
|
|
name: "configuration(Configuration configuration)"
|
|
nameWithType: "ChatThreadClientBuilder.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 ChatThreadClientBuilder configuration(Configuration configuration)"
|
|
desc: "Sets the configuration object used to retrieve environment configuration values during building of the client."
|
|
returns:
|
|
description: "the updated ChatThreadClientBuilder object"
|
|
type: "<xref href=\"com.azure.communication.chat.ChatThreadClientBuilder?alt=com.azure.communication.chat.ChatThreadClientBuilder&text=ChatThreadClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.communication.chat.ChatThreadClientBuilder.credential(com.azure.communication.common.CommunicationTokenCredential)"
|
|
fullName: "com.azure.communication.chat.ChatThreadClientBuilder.credential(CommunicationTokenCredential communicationTokenCredential)"
|
|
name: "credential(CommunicationTokenCredential communicationTokenCredential)"
|
|
nameWithType: "ChatThreadClientBuilder.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 ChatThreadClientBuilder credential(CommunicationTokenCredential communicationTokenCredential)"
|
|
desc: "Set a token credential for authorization"
|
|
returns:
|
|
description: "the updated ChatThreadClientBuilder object"
|
|
type: "<xref href=\"com.azure.communication.chat.ChatThreadClientBuilder?alt=com.azure.communication.chat.ChatThreadClientBuilder&text=ChatThreadClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.communication.chat.ChatThreadClientBuilder.endpoint(java.lang.String)"
|
|
fullName: "com.azure.communication.chat.ChatThreadClientBuilder.endpoint(String endpoint)"
|
|
name: "endpoint(String endpoint)"
|
|
nameWithType: "ChatThreadClientBuilder.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 ChatThreadClientBuilder endpoint(String endpoint)"
|
|
desc: "Set endpoint of the service"
|
|
returns:
|
|
description: "the updated ChatThreadClientBuilder object"
|
|
type: "<xref href=\"com.azure.communication.chat.ChatThreadClientBuilder?alt=com.azure.communication.chat.ChatThreadClientBuilder&text=ChatThreadClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.communication.chat.ChatThreadClientBuilder.httpClient(com.azure.core.http.HttpClient)"
|
|
fullName: "com.azure.communication.chat.ChatThreadClientBuilder.httpClient(HttpClient httpClient)"
|
|
name: "httpClient(HttpClient httpClient)"
|
|
nameWithType: "ChatThreadClientBuilder.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 ChatThreadClientBuilder 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 ChatThreadClientBuilder object"
|
|
type: "<xref href=\"com.azure.communication.chat.ChatThreadClientBuilder?alt=com.azure.communication.chat.ChatThreadClientBuilder&text=ChatThreadClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.communication.chat.ChatThreadClientBuilder.httpLogOptions(com.azure.core.http.policy.HttpLogOptions)"
|
|
fullName: "com.azure.communication.chat.ChatThreadClientBuilder.httpLogOptions(HttpLogOptions logOptions)"
|
|
name: "httpLogOptions(HttpLogOptions logOptions)"
|
|
nameWithType: "ChatThreadClientBuilder.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 ChatThreadClientBuilder 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 ChatThreadClientBuilder object"
|
|
type: "<xref href=\"com.azure.communication.chat.ChatThreadClientBuilder?alt=com.azure.communication.chat.ChatThreadClientBuilder&text=ChatThreadClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.communication.chat.ChatThreadClientBuilder.pipeline(com.azure.core.http.HttpPipeline)"
|
|
fullName: "com.azure.communication.chat.ChatThreadClientBuilder.pipeline(HttpPipeline httpPipeline)"
|
|
name: "pipeline(HttpPipeline httpPipeline)"
|
|
nameWithType: "ChatThreadClientBuilder.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 ChatThreadClientBuilder 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.ChatThreadClientBuilder.endpoint(java.lang.String)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"endpoint\"></xref>."
|
|
returns:
|
|
description: "the updated ChatThreadClientBuilder object"
|
|
type: "<xref href=\"com.azure.communication.chat.ChatThreadClientBuilder?alt=com.azure.communication.chat.ChatThreadClientBuilder&text=ChatThreadClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.communication.chat.ChatThreadClientBuilder.retryOptions(com.azure.core.http.policy.RetryOptions)"
|
|
fullName: "com.azure.communication.chat.ChatThreadClientBuilder.retryOptions(RetryOptions retryOptions)"
|
|
name: "retryOptions(RetryOptions retryOptions)"
|
|
nameWithType: "ChatThreadClientBuilder.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 ChatThreadClientBuilder 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.ChatThreadClientBuilder.retryPolicy(com.azure.core.http.policy.RetryPolicy)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#retryPolicy(RetryPolicy)\"></xref>."
|
|
returns:
|
|
description: "The updated ChatThreadClientBuilder object."
|
|
type: "<xref href=\"com.azure.communication.chat.ChatThreadClientBuilder?alt=com.azure.communication.chat.ChatThreadClientBuilder&text=ChatThreadClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.communication.chat.ChatThreadClientBuilder.retryPolicy(com.azure.core.http.policy.RetryPolicy)"
|
|
fullName: "com.azure.communication.chat.ChatThreadClientBuilder.retryPolicy(RetryPolicy retryPolicy)"
|
|
name: "retryPolicy(RetryPolicy retryPolicy)"
|
|
nameWithType: "ChatThreadClientBuilder.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 ChatThreadClientBuilder 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.ChatThreadClientBuilder.retryOptions(com.azure.core.http.policy.RetryOptions)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#retryOptions(RetryOptions)\"></xref>."
|
|
returns:
|
|
description: "The updated ChatThreadClientBuilder object."
|
|
type: "<xref href=\"com.azure.communication.chat.ChatThreadClientBuilder?alt=com.azure.communication.chat.ChatThreadClientBuilder&text=ChatThreadClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.communication.chat.ChatThreadClientBuilder.serviceVersion(com.azure.communication.chat.ChatServiceVersion)"
|
|
fullName: "com.azure.communication.chat.ChatThreadClientBuilder.serviceVersion(ChatServiceVersion version)"
|
|
name: "serviceVersion(ChatServiceVersion version)"
|
|
nameWithType: "ChatThreadClientBuilder.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 ChatThreadClientBuilder 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 ChatThreadClientBuilder object"
|
|
type: "<xref href=\"com.azure.communication.chat.ChatThreadClientBuilder?alt=com.azure.communication.chat.ChatThreadClientBuilder&text=ChatThreadClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
|
type: "class"
|
|
desc: "Builder for creating clients of Azure Communication Service Chat Threads"
|
|
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.ChatThreadClientBuilder?alt=com.azure.communication.chat.ChatThreadClientBuilder&text=ChatThreadClientBuilder\" 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.ChatThreadClientBuilder?alt=com.azure.communication.chat.ChatThreadClientBuilder&text=ChatThreadClientBuilder\" 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.ChatThreadClientBuilder?alt=com.azure.communication.chat.ChatThreadClientBuilder&text=ChatThreadClientBuilder\" data-throw-if-not-resolved=\"False\" />>"
|
|
metadata: {}
|
|
package: "com.azure.communication.chat"
|
|
artifact: com.azure:azure-communication-chat:1.5.4
|