ktor-client-core/io.ktor.client.plugins.api/ClientPluginBuilder

ClientPluginBuilder

class ClientPluginBuilder<PluginConfig : Any>

An utility class used to build a ClientPlugin instance.

Properties

client

val client: HttpClient

A reference to the HttpClient where the plugin is installed.

pluginConfig

val pluginConfig: PluginConfig

A configuration of the current plugin.

Functions

fun <HookHandler> on(hook: ClientHook<HookHandler>, handler: HookHandler)

Specifies a handler for a specific hook. A hook can be a specific place in time or event during the request processing like receiving a response, an exception during call processing, etc.

onClose

fun onClose(block: () -> Unit)

Specifies the block to clean resources allocated with this plugin.

onRequest

fun onRequest(block: suspend OnRequestContext.(request: HttpRequestBuilder, content: Any) -> Unit)

Specifies the block handler for every HTTP request.

onResponse

fun onResponse(block: suspend OnResponseContext.(response: HttpResponse) -> Unit)

Specifies the block handler for every HTTP response.

transformRequestBody

fun transformRequestBody(block: suspend TransformRequestBodyContext.(request: HttpRequestBuilder, content: Any, bodyType: TypeInfo?) -> OutgoingContent?)

Specifies the block transformer for a request body.

transformResponseBody

fun transformResponseBody(block: suspend TransformResponseBodyContext.(response: HttpResponse, content: ByteReadChannel, requestedType: TypeInfo) -> Any?)

Specifies the block transformer for a response body.