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

ClientPlugin

interface ClientPlugin<PluginConfig : Any> : HttpClientPlugin<PluginConfig, ClientPluginInstance<PluginConfig>> (source)

Client plugins factory.

Report a problem

Properties

Link copied to clipboard
abstract val key: AttributeKey<ClientPluginInstance<PluginConfig>>

The AttributeKey for this plugin.

Functions

Link copied to clipboard
abstract fun install(plugin: ClientPluginInstance<PluginConfig>, scope: HttpClient)

Installs the plugin class for a HttpClient defined at scope.

Link copied to clipboard
abstract fun prepare(block: PluginConfig.() -> Unit = {}): ClientPluginInstance<PluginConfig>

Builds a TPlugin by calling the block with a TConfig config instance as receiver.