Skip to content

//okhttp/okhttp3/RequestBody/Companion

Companion

[common]\ expect object Companion

[jvm, nonJvm]\ actual object Companion

Functions

Name Summary
asRequestBody [jvm]
@JvmStatic
@JvmName(name = "create")
fun File.asRequestBody(contentType: MediaType? = null): RequestBody
@JvmStatic
@JvmName(name = "create")
fun Path.asRequestBody(fileSystem: FileSystem, contentType: MediaType? = null): RequestBody
Returns a new request body that transmits the content of this.
gzip [jvm]
@JvmStatic
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.
toRequestBody [jvm, common]
[jvm]
@JvmStatic
@JvmName(name = "create")
fun FileDescriptor.toRequestBody(contentType: MediaType? = null): RequestBody
[common]
@JvmOverloads
expect fun ByteString.toRequestBody(contentType: MediaType? = null): RequestBody
[common]
@JvmOverloads
expect fun ByteArray.toRequestBody(contentType: MediaType? = null, offset: Int = 0, byteCount: Int = size): RequestBody
Returns a new request body that transmits this.
[common, jvm]
[common]
@JvmOverloads
expect fun String.toRequestBody(contentType: MediaType? = null): RequestBody
[jvm]
@JvmStatic
@JvmName(name = "create")
actual fun String.toRequestBody(contentType: MediaType?): RequestBody
Returns a new request body that transmits this string. If contentType is non-null and lacks a charset, this will use UTF-8.
[nonJvm, jvm]
[nonJvm]
actual fun String.toRequestBody(contentType: MediaType?): RequestBody
[jvm]
@JvmStatic
@JvmName(name = "create")
actual fun ByteString.toRequestBody(contentType: MediaType?): RequestBody
[nonJvm]
actual fun ByteString.toRequestBody(contentType: MediaType?): RequestBody
[jvm]
@JvmOverloads
@JvmStatic
@JvmName(name = "create")
actual fun ByteArray.toRequestBody(contentType: MediaType?, offset: Int, byteCount: Int): RequestBody
[nonJvm]
actual fun ByteArray.toRequestBody(contentType: MediaType?, offset: Int, byteCount: Int): RequestBody