RestClient.Builder 類別

  • java.lang.Object
    • com.microsoft.bot.restclient.RestClient.Builder

public static class RestClient.Builder

建置 REST 用戶端的產生器類別。

建構函式摘要

建構函式 Description
Builder()

使用服務的基底 URL 建立產生器的實例。

Builder(OkHttpClient.Builder httpClientBuilder, Retrofit.Builder retrofitBuilder)

使用基底 URL 和 2 個自定義產生器,建立產生器的實例。

方法摘要

修飾詞與類型 方法與描述
RestClient build()

使用所有目前設定建置 RestClient。

Builder useHttpClientThreadPool(boolean useHttpClientThreadPool)

設定是否要在 [確定]Http 用戶端或 RxJava 排程器中使用線程集區。

Builder withBaseUrl(Environment environment, Environment.Endpoint endpoint)

使用環境的預設設定基底 URL。

Builder withBaseUrl(String baseUrl)

設定動態基底 URL。

Builder withCallbackExecutor(Executor executor)

設定要執行之異步回呼的執行程式。

Builder withConnectionPool(ConnectionPool connectionPool)

設定 Http 用戶端的連接集區。

Builder withConnectionTimeout(long timeout, TimeUnit unit)

在 HTTP 用戶端上設定連線逾時。

Builder withCredentials(ServiceClientCredentials credentials)

設定認證。

Builder withDispatcher(Dispatcher dispatcher)

設定OkHttp 用戶端中使用的發送器。

Builder withInterceptor(Interceptor interceptor)

新增 Http 用戶端管線的攔截器。

Builder withLogLevel(LogLevel logLevel)

設定 HTTP 記錄層級。

Builder withMaxIdleConnections(int maxIdleConnections)

已被取代

設定 HTTP 用戶端的最大閑置連線。

Builder withNetworkInterceptor(Interceptor networkInterceptor)

新增 Http 用戶端管線的網路層攔截器。

Builder withProxy(Proxy proxy)

設定 HTTP 用戶端的 Proxy。

Builder withProxyAuthenticator(Authenticator proxyAuthenticator)

設定 HTTP 用戶端的 Proxy 驗證器。

Builder withReadTimeout(long timeout, TimeUnit unit)

在 HTTP 用戶端上設定讀取逾時。

Builder withResponseBuilderFactory(ResponseBuilder.Factory responseBuilderFactory)

設定回應產生器處理站。

Builder withRetryStrategy(RetryStrategy strategy)

將重試策略新增至用戶端。

Builder withSerializerAdapter(SerializerAdapter<?> serializerAdapter)

設定串行化配接器。

Builder withUserAgent(String userAgent)

設定使用者代理程序標頭。

方法繼承來源 java.lang.Object

java.lang.Object.clone java.lang.Object.equals java.lang.Object.finalize java.lang.Object.getClass java.lang.Object.hashCode java.lang.Object.notify java.lang.Object.notifyAll java.lang.Object.toString java.lang.Object.wait java.lang.Object.wait java.lang.Object.wait

建構函式詳細資料

Builder

public Builder()

使用服務的基底 URL 建立產生器的實例。

Builder

public Builder(OkHttpClient.Builder httpClientBuilder, Retrofit.Builder retrofitBuilder)

使用基底 URL 和 2 個自定義產生器,建立產生器的實例。

參數:

httpClientBuilder - 建置 OkHttpClient的建置器。
retrofitBuilder - 建置 Retrofit的建置器。

方法詳細資料

build

public RestClient build()

使用所有目前的組態建置 RestClient。

傳回:

useHttpClientThreadPool

public RestClient.Builder useHttpClientThreadPool(boolean useHttpClientThreadPool)

設定是否要在OkHttp用戶端或 RxJava 排程器中使用線程集區。 如果設定為 true,將會使用 OkHttp 用戶端中的線程集區。 默認值為 false。

參數:

useHttpClientThreadPool - 是否要在OkHTTP用戶端中使用線程集區。 默認值為 false。

傳回:

鏈結的產生器本身

withBaseUrl

public RestClient.Builder withBaseUrl(Environment environment, Environment.Endpoint endpoint)

使用環境的預設設定基底 URL。

參數:

environment - 要使用的環境
endpoint - 應用程式正在存取的環境端點

傳回:

鏈結的產生器本身

withBaseUrl

public RestClient.Builder withBaseUrl(String baseUrl)

設定動態基底 URL。

參數:

baseUrl - 要使用的基底 URL。

傳回:

鏈結的產生器本身。

withCallbackExecutor

public RestClient.Builder withCallbackExecutor(Executor executor)

設定要執行之異步回呼的執行程式。

參數:

executor - 要執行回呼的執行程式。

傳回:

鏈結的產生器本身

withConnectionPool

public RestClient.Builder withConnectionPool(ConnectionPool connectionPool)

設定 Http 用戶端的連接集區。

參數:

connectionPool - 要使用的OkHttp 3線上集區

傳回:

鏈結的產生器本身

withConnectionTimeout

public RestClient.Builder withConnectionTimeout(long timeout, TimeUnit unit)

在 HTTP 用戶端上設定連線逾時。 預設值為10秒。

參數:

timeout - 逾時數值
unit - 數值的時間單位

傳回:

鏈結的產生器本身

withCredentials

public RestClient.Builder withCredentials(ServiceClientCredentials credentials)

設定認證。

參數:

credentials - 認證物件。

傳回:

鏈結的產生器本身。

withDispatcher

public RestClient.Builder withDispatcher(Dispatcher dispatcher)

設定OkHttp用戶端中使用的發送器。 這也是設定執行 HTTP 要求之線程集區的位置。

參數:

dispatcher - 要使用的發送器

傳回:

鏈結的產生器本身

withInterceptor

public RestClient.Builder withInterceptor(Interceptor interceptor)

新增 Http 用戶端管線的攔截器。

參數:

interceptor - 要加入的攔截器。

傳回:

鏈結的產生器本身。

withLogLevel

public RestClient.Builder withLogLevel(LogLevel logLevel)

設定 HTTP 記錄層級。

參數:

logLevel - LogLevel 列舉。

傳回:

鏈結的產生器本身。

withMaxIdleConnections


public RestClient.Builder withMaxIdleConnections(int maxIdleConnections)

已被取代

設定 HTTP 用戶端的最大閑置連線。 預設值為 5。

參數:

maxIdleConnections - 閑置連線上限

傳回:

鏈結的產生器本身

withNetworkInterceptor

public RestClient.Builder withNetworkInterceptor(Interceptor networkInterceptor)

新增 Http 用戶端管線的網路層攔截器。

參數:

networkInterceptor - 要加入的攔截器。

傳回:

鏈結的產生器本身。

withProxy

public RestClient.Builder withProxy(Proxy proxy)

設定 HTTP 用戶端的 Proxy。

參數:

proxy - 要使用的 Proxy

傳回:

鏈結的產生器本身

withProxyAuthenticator

public RestClient.Builder withProxyAuthenticator(Authenticator proxyAuthenticator)

設定 HTTP 用戶端的 Proxy 驗證器。

參數:

proxyAuthenticator - 要使用的 Proxy 驗證器

傳回:

鏈結的產生器本身

withReadTimeout

public RestClient.Builder withReadTimeout(long timeout, TimeUnit unit)

在 HTTP 用戶端上設定讀取逾時。 預設值為10秒。

參數:

timeout - 逾時數值
unit - 數值的時間單位

傳回:

鏈結的產生器本身

withResponseBuilderFactory

public RestClient.Builder withResponseBuilderFactory(ResponseBuilder.Factory responseBuilderFactory)

設定回應產生器處理站。

參數:

responseBuilderFactory - 回應產生器處理站

傳回:

鏈結的產生器本身

withRetryStrategy

public RestClient.Builder withRetryStrategy(RetryStrategy strategy)

將重試策略新增至用戶端。

參數:

strategy - 要新增的重試策略

傳回:

鏈結的產生器本身

withSerializerAdapter

public RestClient.Builder withSerializerAdapter(SerializerAdapter serializerAdapter)

設定串行化配接器。

參數:

serializerAdapter - 串行化程式的配接器

傳回:

鏈結的產生器本身

withUserAgent

public RestClient.Builder withUserAgent(String userAgent)

設定使用者代理程序標頭。

參數:

userAgent - 使用者代理程序標頭。

傳回:

鏈結的產生器本身。

適用於