ktor-client-core/io.ktor.client.call

Package io.ktor.client.call

Types

Link copied to clipboard
class DoubleReceiveException(call: HttpClientCall) : IllegalStateException
Content copied to clipboard

Exception representing that the response payload has already been received.

Link copied to clipboard
open class HttpClientCall : CoroutineScope
Content copied to clipboard

A class that represents a single pair of request and response for a specific HttpClient.

Link copied to clipboard
data class HttpEngineCall(request: HttpRequest, response: HttpResponse)
Content copied to clipboard

Raw http call produced by engine.

Link copied to clipboard
class NoTransformationFoundException(response: HttpResponse, from: KClass<*>, to: KClass<*>) : UnsupportedOperationException
Content copied to clipboard

Exception representing the no transformation was found. It includes the received type and the expected type as part of the message.

Link copied to clipboard
class ReceivePipelineException constructor(request: HttpClientCall, info: TypeInfo, cause: Throwable) : IllegalStateException
Content copied to clipboard

Exception representing fail of the response pipeline cause contains origin pipeline exception

Link copied to clipboard
typealias Type = io.ktor.util.reflect.Type
Content copied to clipboard

Information about type.

Link copied to clipboard
data class TypeInfo(type: KClass<*>, reifiedType: Type, kotlinType: KType?) : TypeInfo
Content copied to clipboard

Ktor type information.

Link copied to clipboard
class UnsupportedContentTypeException(content: OutgoingContent) : IllegalStateException
Content copied to clipboard
Link copied to clipboard
class UnsupportedUpgradeProtocolException(url: Url) : IllegalArgumentException
Content copied to clipboard

Functions

Link copied to clipboard
suspend fun HttpClient.call(builder: HttpRequestBuilder): HttpClientCall
Content copied to clipboard

Constructs a HttpClientCall from this HttpClient and with the specified HTTP request builder.

suspend fun HttpClient.call(block: suspend HttpRequestBuilder.() -> Unit = {}): HttpClientCall
Content copied to clipboard

Constructs a HttpClientCall from this HttpClient and with the specified HttpRequestBuilder configured inside the block.

suspend fun HttpClient.call(url: Url, block: suspend HttpRequestBuilder.() -> Unit = {}): HttpClientCall
Content copied to clipboard

Constructs a HttpClientCall from this HttpClient, an url and an optional block configuring a HttpRequestBuilder.

suspend fun HttpClient.call(urlString: String, block: suspend HttpRequestBuilder.() -> Unit = {}): HttpClientCall
Content copied to clipboard

Constructs a HttpClientCall from this HttpClient, an url and an optional block configuring a HttpRequestBuilder.

suspend fun HttpClient.call(url: URL, block: HttpRequestBuilder.() -> Unit = {}): HttpClientCall
Content copied to clipboard

Constructs a HttpClientCall from this HttpClient, an url and an optional block configuring a HttpRequestBuilder.

Link copied to clipboard
inline suspend fun <T> HttpClientCall.receive(): T
Content copied to clipboard

Tries to receive the payload of the response as a specific type T.

inline suspend fun <T> HttpResponse.receive(): T
Content copied to clipboard

Tries to receive the payload of the response as a specific type T described in typeInfo.

Link copied to clipboard
suspend fun HttpClientCall.save(): HttpClientCall
Content copied to clipboard

Fetch data for HttpClientCall and close the origin.

Link copied to clipboard
inline fun <T> typeInfo(): TypeInfo
Content copied to clipboard

Returns TypeInfo for the specified type T