com.azure.android.communication.chat

Class ChatThreadClientBuilder

java.lang.Object

com.azure.android.communication.chat.ChatThreadClientBuilder

public final class ChatThreadClientBuilder
extends java.lang.Object

Builder for creating clients of Azure Communication Service Chat

Constructor Summary

Constructors

Constructor and Description
ChatThreadClientBuilder()

Method Summary

Modifier and Type	Method and Description
ChatThreadClientBuilder	addPolicy(com.azure.android.core.http.HttpPipelinePolicy pipelinePolicy) Apply additional HttpPipelinePolicy
ChatThreadAsyncClient	buildAsyncClient() Create asynchronous chat thread client applying CommunicationTokenCredential, UserAgentPolicy, RetryPolicy, and CookiePolicy.
ChatThreadClient	buildClient() Create synchronous chat thread client applying CommunicationTokenCredential, UserAgentPolicy, RetryPolicy, and CookiePolicy.
ChatThreadClientBuilder	chatThreadId(java.lang.String chatThreadId) Sets the ChatThreadId used to construct a client for this chat thread.
ChatThreadClientBuilder	credential(com.azure.android.communication.common.CommunicationTokenCredential communicationTokenCredential) Set a token credential for authorization
ChatThreadClientBuilder	endpoint(java.lang.String endpoint) Set endpoint of the service
ChatThreadClientBuilder	httpClient(com.azure.android.core.http.HttpClient httpClient) Set HttpClient to use
ChatThreadClientBuilder	httpLogOptions(com.azure.android.core.http.policy.HttpLogOptions logOptions) Sets the HttpLogOptions for service requests.
ChatThreadClientBuilder	pipeline(com.azure.android.core.http.HttpPipeline httpPipeline) Sets the HttpPipeline to use for the service client.
ChatThreadClientBuilder	retryPolicy(com.azure.android.core.http.policy.RetryPolicy retryPolicy) Sets the RetryPolicy that will attempt to retry failed requests, if applicable.
ChatThreadClientBuilder	serviceVersion(ChatServiceVersion serviceVersion) Sets the ChatServiceVersion that is used when making API requests.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ChatThreadClientBuilder

public ChatThreadClientBuilder()

Method Detail

endpoint

public ChatThreadClientBuilder endpoint(java.lang.String endpoint)

Set endpoint of the service

Parameters:

endpoint - url of the service

Returns:

The updated ChatThreadClientBuilder object

Throws:

java.lang.NullPointerException - if endpoint is null.

httpClient

public ChatThreadClientBuilder httpClient(com.azure.android.core.http.HttpClient httpClient)

Set HttpClient to use

Parameters:

httpClient - HttpClient to use

Returns:

The updated ChatThreadClientBuilder object

Throws:

java.lang.NullPointerException - if httpClient is null.

credential

public ChatThreadClientBuilder credential(com.azure.android.communication.common.CommunicationTokenCredential communicationTokenCredential)

Set a token credential for authorization

Parameters:

communicationTokenCredential - valid token credential as a string

Returns:

The updated ChatThreadClientBuilder object

Throws:

java.lang.NullPointerException - if communicationTokenCredential is null.

addPolicy

public ChatThreadClientBuilder addPolicy(com.azure.android.core.http.HttpPipelinePolicy pipelinePolicy)

Apply additional HttpPipelinePolicy

Parameters:

pipelinePolicy - HttpPipelinePolicy objects to be applied after AzureKeyCredentialPolicy, UserAgentPolicy, RetryPolicy, and CookiePolicy

Returns:

The updated ChatThreadClientBuilder object

Throws:

java.lang.NullPointerException - if pipelinePolicy is null.

retryPolicy

public ChatThreadClientBuilder retryPolicy(com.azure.android.core.http.policy.RetryPolicy retryPolicy)

Sets the RetryPolicy that will attempt to retry failed requests, if applicable.

Parameters:

retryPolicy - the retryPolicy value.

Returns:

The updated ChatThreadClientBuilder object.

Throws:

java.lang.NullPointerException - if retryPolicy is null.

httpLogOptions

public ChatThreadClientBuilder httpLogOptions(com.azure.android.core.http.policy.HttpLogOptions logOptions)

Sets the HttpLogOptions for service requests.

Parameters:

logOptions - The logging configuration to use when sending and receiving HTTP requests/responses.

Returns:

The updated ChatThreadClientBuilder object

Throws:

java.lang.NullPointerException - if logOptions is null.

serviceVersion

public ChatThreadClientBuilder serviceVersion(ChatServiceVersion serviceVersion)

Sets the ChatServiceVersion that is used when making API requests.

If 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.

Targeting a specific service version may also mean that the service will return an error for newer APIs.

Parameters:

serviceVersion - ChatServiceVersion of the service to be used when making requests.

Returns:

The updated ChatThreadClientBuilder object.

pipeline

public ChatThreadClientBuilder pipeline(com.azure.android.core.http.HttpPipeline httpPipeline)

Sets the HttpPipeline to use for the service client. If pipeline is set, all other settings are ignored, aside from endpoint.

Parameters:

httpPipeline - HttpPipeline to use for sending service requests and receiving responses.

Returns:

The updated ChatThreadClientBuilder object.

chatThreadId

public ChatThreadClientBuilder chatThreadId(java.lang.String chatThreadId)

Sets the ChatThreadId used to construct a client for this chat thread.

Parameters:

chatThreadId - The id of the chat thread.

Returns:

The updated ChatThreadClientBuilder object.

buildClient

public ChatThreadClient buildClient()

Create synchronous chat thread client applying CommunicationTokenCredential, UserAgentPolicy, RetryPolicy, and CookiePolicy. Additional HttpPolicies specified by additionalPolicies will be applied after them

Returns:

A ChatThreadClient instance.

Throws:

java.lang.NullPointerException - if chatThreadId, endpoint or communicationTokenCredential is not set.

buildAsyncClient

public ChatThreadAsyncClient buildAsyncClient()

Create asynchronous chat thread client applying CommunicationTokenCredential, UserAgentPolicy, RetryPolicy, and CookiePolicy. Additional HttpPolicies specified by additionalPolicies will be applied after them

Returns:

A ChatThreadAsyncClient instance.

Throws:

java.lang.NullPointerException - if chatThreadId, endpoint or communicationTokenCredential is not set.