okhttp/okhttp3/Request/Builder

Builder

open class Builder

Constructors

Builder

constructor()

Functions

addHeader

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".

build

open fun build(): Request

cacheControl

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.

cacheUrlOverride

fun cacheUrlOverride(cacheUrlOverride: HttpUrl?): Request.Builder

Override the Request.url for caching, if it is either polluted with transient query params, or has a canonical URL possibly for a CDN.

delete

open fun delete(body: RequestBody? = RequestBody.EMPTY): Request.Builder

get

open fun get(): Request.Builder

gzip

fun gzip(): Request.Builder

Configures this request's body to be compressed when it is transmitted. This also adds the 'Content-Encoding: gzip' header.

head

open fun head(): Request.Builder

header

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.

headers

open fun headers(headers: Headers): Request.Builder

Removes all headers on this builder and adds headers.

method

open fun method(method: String, body: RequestBody?): Request.Builder

patch

open fun patch(body: RequestBody): Request.Builder

post

open fun post(body: RequestBody): Request.Builder

put

open fun put(body: RequestBody): Request.Builder

removeHeader

open fun removeHeader(name: String): Request.Builder

Removes all headers named name on this builder.

tag

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.

open fun tag(tag: Any?): Request.Builder

Attaches tag to the request using Object.class as a key.

open fun <T> tag(type: <Error class: unknown class><in T>, tag: T?): <Error class: unknown class>

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

open fun url(url: <Error class: unknown class>): <Error class: unknown class>

open fun url(url: String): Request.Builder

Sets the URL target of this request.

open fun url(url: HttpUrl): Request.Builder