readium-shared/org.readium.r2.shared.util.http/HttpRequest/Builder

Builder

class Builder(val url: AbsoluteUrl, var method: HttpRequest.Method = Method.GET, var headers: MutableMap<String, MutableList<String>> = mutableMapOf(), var body: HttpRequest.Body? = null, var extras: Bundle = Bundle(), var connectTimeout: Duration? = null, var readTimeout: Duration? = null, var allowUserInteraction: Boolean = false)

Constructors

constructor(url: AbsoluteUrl, method: HttpRequest.Method = Method.GET, headers: MutableMap<String, MutableList<String>> = mutableMapOf(), body: HttpRequest.Body? = null, extras: Bundle = Bundle(), connectTimeout: Duration? = null, readTimeout: Duration? = null, allowUserInteraction: Boolean = false)

Properties

allowUserInteraction

var allowUserInteraction: Boolean

var body: HttpRequest.Body?

var connectTimeout: Duration?

var extras: Bundle

var headers: MutableMap<String, MutableList<String>>

var method: HttpRequest.Method

var readTimeout: Duration?

val url: AbsoluteUrl

Functions

fun addHeader(key: String, value: String): HttpRequest.Builder

Adds value to header values associated with key.

appendQueryParameter

fun appendQueryParameter(key: String, value: String?): HttpRequest.Builder

appendQueryParameters

fun appendQueryParameters(params: Map<String, String?>): HttpRequest.Builder

fun build(): HttpRequest

fun setHeader(key: String, value: String): HttpRequest.Builder

Sets header with key to value overriding current values, if any.

fun setHeader(key: String, values: List<String>): HttpRequest.Builder

Sets header with key key to values overriding current values, if any.

fun setPostForm(form: Map<String, String?>): HttpRequest.Builder

Initializes a POST request with the given form data.

fun setRange(range: LongRange): HttpRequest.Builder

Issue a byte range request. Use -1 to download until the end.