Skip to content

//okhttp/okhttp3/Request/Builder

Builder

[common]\ expect open class Builder

[jvm, nonJvm]\ actual open class Builder

Constructors

Builder [common]
expect fun Builder()
[jvm, nonJvm]
actual fun Builder()

Functions

Name Summary
addHeader [common]
expect open fun addHeader(name: String, value: String): Request.Builder
Adds a header with name and value. Prefer this method for multiply-valued headers like "Cookie".
[jvm, nonJvm]
[jvm, nonJvm]
actual open fun addHeader(name: String, value: String): Request.Builder
build [common, jvm, nonJvm]
[common]
expect open fun build(): Request
[jvm, nonJvm]
actual open fun build(): Request
cacheControl [common]
expect open fun cacheControl(cacheControl: CacheControl): Request.Builder
Sets this request’s Cache-Control header, replacing any cache control headers already present. If cacheControl doesn’t define any directives, this clears this request’s cache-control headers.
[jvm, nonJvm]
[jvm, nonJvm]
actual open fun cacheControl(cacheControl: CacheControl): Request.Builder
delete [common, jvm, nonJvm]
[common]
expect open fun delete(body: RequestBody? = commonEmptyRequestBody): Request.Builder
[jvm]
@JvmOverloads
actual open fun delete(body: RequestBody?): Request.Builder
[nonJvm]
actual open fun delete(body: RequestBody?): Request.Builder
get [common, jvm, nonJvm]
[common]
expect open fun get(): Request.Builder
[jvm, nonJvm]
actual open fun get(): Request.Builder
head [common, jvm, nonJvm]
[common]
expect open fun head(): Request.Builder
[jvm, nonJvm]
actual open fun head(): Request.Builder
header [common]
expect open fun header(name: String, value: String): Request.Builder
Sets the header named name to value. If this request already has any headers with that name, they are all replaced.
[jvm, nonJvm]
[jvm, nonJvm]
actual open fun header(name: String, value: String): Request.Builder
headers [common]
expect open fun headers(headers: Headers): Request.Builder
Removes all headers on this builder and adds headers.
[jvm, nonJvm]
[jvm, nonJvm]
actual open fun headers(headers: Headers): Request.Builder
method [common, jvm, nonJvm]
[common]
expect open fun method(method: String, body: RequestBody?): Request.Builder
[jvm, nonJvm]
actual open fun method(method: String, body: RequestBody?): Request.Builder
patch [common, jvm, nonJvm]
[common]
expect open fun patch(body: RequestBody): Request.Builder
[jvm, nonJvm]
actual open fun patch(body: RequestBody): Request.Builder
post [common, jvm, nonJvm]
[common]
expect open fun post(body: RequestBody): Request.Builder
[jvm, nonJvm]
actual open fun post(body: RequestBody): Request.Builder
put [common, jvm, nonJvm]
[common]
expect open fun put(body: RequestBody): Request.Builder
[jvm, nonJvm]
actual open fun put(body: RequestBody): Request.Builder
removeHeader [common]
expect open fun removeHeader(name: String): Request.Builder
Removes all headers named name on this builder.
[jvm, nonJvm]
[jvm, nonJvm]
actual open fun removeHeader(name: String): Request.Builder
tag [common]
expect inline fun <T : Any> tag(tag: T?): Request.Builder
Attaches tag to the request using T as a key. Tags can be read from a request using Request.tag. Use null to remove any existing tag assigned for T.
[jvm, nonJvm]
[jvm]
@JvmName(name = "reifiedTag")
actual inline fun <T : Any> tag(tag: T?): Request.Builder
[nonJvm]
actual inline fun <T : Any> tag(tag: T?): Request.Builder
[jvm, nonJvm]
actual fun <T : Any> tag(type: KClass<T>, tag: T?): Request.Builder
[jvm]
open fun tag(tag: Any?): Request.Builder
Attaches tag to the request using Object.class as a key.
[jvm, common]
[jvm]
open fun <T> tag(type: Class<in T>, tag: T?): Request.Builder
[common]
expect fun <T : Any> tag(type: KClass<T>, tag: T?): Request.Builder
Attaches tag to the request using type as a key. Tags can be read from a request using Request.tag. Use null to remove any existing tag assigned for type.
url [jvm, common]
[jvm]
open fun url(url: URL): Request.Builder
[common]
expect open fun url(url: String): Request.Builder
Sets the URL target of this request.
[jvm, nonJvm]
[jvm, nonJvm]
actual open fun url(url: String): Request.Builder
[jvm]
open fun url(url: HttpUrl): Request.Builder