ktor-client-core/io.ktor.client.plugins/DefaultRequest/DefaultRequestBuilder

DefaultRequestBuilder

class DefaultRequestBuilder : HttpMessageBuilder(source)

Configuration object for DefaultRequestBuilder plugin

Report a problem

Properties

val attributes: Attributes

open override val headers: HeadersBuilder

var host: String

Gets the associated URL's host.

Gets the associated URL's port.

val url: URLBuilder

Functions

fun HttpMessageBuilder.accept(contentType: ContentType)

Appends the Accept header with a specific contentType.

fun HttpMessageBuilder.basicAuth(username: String, password: String)

Appends the HttpHeaders.Authorization to Basic Authorization with the provided username and password. For advanced configuration use the io.ktor:ktor-client-auth plugin.

fun HttpMessageBuilder.bearerAuth(token: String)

Appends the HttpHeaders.Authorization to Bearer Authorization with the provided token. For advanced configuration use the io.ktor:ktor-client-auth plugin.

fun HttpMessageBuilder.cookie(name: String, value: String, maxAge: Int = 0, expires: GMTDate? = null, domain: String? = null, path: String? = null, secure: Boolean = false, httpOnly: Boolean = false, extensions: Map<String, String?> = emptyMap())

Appends a single header of key with a specific value if the value is not null.

fun HttpMessageBuilder.header(key: String, value: Any?)

Appends a single header of key with a specific value if the value is not null.

fun headers(block: HeadersBuilder.() -> Unit): HeadersBuilder

Executes a block that configures the HeadersBuilder associated to this request.

fun HttpMessageBuilder.headers(block: HeadersBuilder.() -> Unit): HeadersBuilder

Executes a block that configures the HeadersBuilder associated to this request.

fun setAttributes(block: Attributes.() -> Unit)

Sets attributes using block.

fun <T : Any> setCapability(key: HttpClientEngineCapability<T>, capability: T)

fun unixSocket(path: String)

fun url(block: URLBuilder.() -> Unit)

Executes a block that configures the URLBuilder associated to this request.

fun url(urlString: String)

Sets the HttpRequestBuilder.url from urlString.

fun url(scheme: String? = null, host: String? = null, port: Int? = null, path: String? = null, block: URLBuilder.() -> Unit = {})

Sets the url using the specified scheme, host, port and path. Pass null to keep existing value in the URLBuilder.