ktor-client-core/io.ktor.client.request.forms

Package-level declarations

Types

class ChannelProvider(val size: Long? = null, val block: () -> ByteReadChannel)

Supplies a new ByteReadChannel.

A form builder type used in the formData builder function.

OutgoingContent with for the application/x-www-form-urlencoded formatted request.

data class FormPart<T : Any>(val key: String, val value: T, val headers: Headers = Headers.Empty)

A multipart form item. Use it to build a form in client.

class InputProvider(val size: Long? = null, val block: () -> Input)

A reusable Input form entry.

class MultiPartFormDataContent(parts: List<PartData>, val boundary: String = generateBoundary(), val contentType: ContentType = ContentType.MultiPart.FormData.withParameter("boundary", boundary)) : OutgoingContent.WriteChannelContent

OutgoingContent for a multipart/form-data formatted request.

inline fun FormBuilder.append(key: String, headers: Headers = Headers.Empty, size: Long? = null, crossinline bodyBuilder: Sink.() -> Unit)

Appends a form part with the specified key using bodyBuilder for its body.

fun FormBuilder.append(key: String, filename: String, contentType: ContentType? = null, size: Long? = null, bodyBuilder: Sink.() -> Unit)

Appends a form part with the specified key, filename, and optional contentType using bodyBuilder for its body.

Builds a multipart form from values.

Build multipart form using block function.

inline suspend fun HttpClient.prepareForm(formParameters: Parameters = Parameters.Empty, encodeInQuery: Boolean = false, block: HttpRequestBuilder.() -> Unit = {}): HttpStatement

suspend fun HttpClient.prepareForm(url: String, formParameters: Parameters = Parameters.Empty, encodeInQuery: Boolean = false, block: HttpRequestBuilder.() -> Unit = {}): HttpStatement

Prepares a request containing form parameters encoded using the x-www-form-urlencoded format.

Prepares a POST request containing form parameters encoded using the multipart/form-data format.

inline suspend fun HttpClient.submitForm(formParameters: Parameters = Parameters.Empty, encodeInQuery: Boolean = false, block: HttpRequestBuilder.() -> Unit = {}): HttpResponse

suspend fun HttpClient.submitForm(url: String, formParameters: Parameters = Parameters.Empty, encodeInQuery: Boolean = false, block: HttpRequestBuilder.() -> Unit = {}): HttpResponse

Makes a request containing form parameters encoded using the x-www-form-urlencoded format.

Makes a POST request containing form parameters encoded using the multipart/form-data format.