ktor-client-core/io.ktor.client/HttpClientConfig

HttpClientConfig

class HttpClientConfig<T : HttpClientEngineConfig>

A mutable HttpClient configuration. Learn more about the client's configuration from Creating and configuring a client.

Constructors

HttpClientConfig

fun HttpClientConfig()

Functions

clone

fun clone(): HttpClientConfig<T>

Clones this HttpClientConfig by duplicating all the plugins and customInterceptors.

engine

fun engine(block: T.() -> Unit)

Allows you to configure engine parameters.

install

fun install(client: HttpClient)

Applies all the installed plugins and customInterceptors from this configuration into the specified client.

fun <TBuilder : Any, TPlugin : Any> install(plugin: HttpClientPlugin<TBuilder, TPlugin>, configure: TBuilder.() -> Unit = {})

Installs the specified plugin and optionally configures it using the configure block. Learn more from Plugins.

fun install(key: String, block: HttpClient.() -> Unit)

Installs an interceptor defined by block. The key parameter is used as a unique name, that also prevents installing duplicated interceptors.

plusAssign

operator fun plusAssign(other: HttpClientConfig<out T>)

Installs the plugin from the other client's configuration.

Properties

developmentMode

var developmentMode: Boolean

Indicates whether the client should use development mode. In development mode, the client's pipelines have advanced stack traces.

expectSuccess

var expectSuccess: Boolean = false

Terminates HttpClient.receivePipeline if the status code is not successful (>=300). Learn more from Response validation.

followRedirects

var followRedirects: Boolean = true

Specifies whether the client redirects to URLs provided in the Location header. You can disable redirections by setting this property to false.

useDefaultTransformers

var useDefaultTransformers: Boolean = true

Uses defaultTransformers to automatically handle simple ContentType.

Extensions

addDefaultResponseValidation

fun HttpClientConfig<*>.addDefaultResponseValidation()

Default response validation. Check the response status code in range (0..299).

BrowserUserAgent

fun HttpClientConfig<*>.BrowserUserAgent()

Installs the UserAgent plugin with a browser-like user agent.

Charsets

fun HttpClientConfig<*>.Charsets(block: HttpPlainText.Config.() -> Unit)

Configure client charsets.

CurlUserAgent

fun HttpClientConfig<*>.CurlUserAgent()

Installs the UserAgent plugin with a CURL user agent.

defaultRequest

fun HttpClientConfig<*>.defaultRequest(block: DefaultRequest.DefaultRequestBuilder.() -> Unit)

Set default request parameters. See DefaultRequest

HttpResponseValidator

fun HttpClientConfig<*>.HttpResponseValidator(block: HttpCallValidator.Config.() -> Unit)

Install HttpCallValidator with block configuration.

ResponseObserver

fun HttpClientConfig<*>.ResponseObserver(block: ResponseHandler)

Install ResponseObserver plugin in client.

WebSockets

fun HttpClientConfig<*>.WebSockets(config: WebSockets.Config.() -> Unit)

Installs the WebSockets plugin using the config as configuration.