okhttp/okhttp3/MultipartBody

MultipartBody

class MultipartBody : RequestBody

An RFC 2387-compliant request body.

Types

class Builder @JvmOverloads constructor(boundary: String = UUID.randomUUID().toString())

object Companion

class Part

Properties

@get:JvmName(name = "boundary")

val boundary: String

@get:JvmName(name = "parts")

val parts: List<MultipartBody.Part>

@get:JvmName(name = "size")

The number of parts in this multipart body.

@get:JvmName(name = "type")

val type: MediaType

Functions

open override fun contentLength(): Long

Returns the number of bytes that will be written to sink in a call to writeTo, or -1 if that count is unknown.

open override fun contentType(): MediaType

A combination of type and boundaryByteString.

@ExperimentalOkHttpApi

fun RequestBody.gzip(): RequestBody

Returns a gzip version of the RequestBody, with compressed payload. This is not automatic as not all servers support gzip compressed requests.

open fun isDuplex(): Boolean

A duplex request body is special in how it is transmitted on the network and in the API contract between OkHttp and the application.

open override fun isOneShot(): Boolean

Returns true if this body expects at most one call to writeTo and can be transmitted at most once. This is typically used when writing the request body is destructive and it is not possible to recreate the request body after it has been sent.

fun part(index: Int): MultipartBody.Part

open override fun writeTo(sink: BufferedSink)

Writes the content of this request to sink.