okhttp3

Class RequestBody

java.lang.Object

okhttp3.RequestBody

Direct Known Subclasses:

FormBody, MultipartBody

public abstract class RequestBody
extends Object

Constructor Summary

Constructors

Constructor and Description
RequestBody()

Method Summary

Modifier and Type	Method and Description
long	contentLength() Returns the number of bytes that will be written to sink in a call to writeTo(okio.BufferedSink), or -1 if that count is unknown.
abstract MediaType	contentType() Returns the Content-Type header for this body.
static RequestBody	create(MediaType contentType, byte[] content) Returns a new request body that transmits content.
static RequestBody	create(MediaType contentType, byte[] content, int offset, int byteCount) Returns a new request body that transmits content.
static RequestBody	create(MediaType contentType, okio.ByteString content) Returns a new request body that transmits content.
static RequestBody	create(MediaType contentType, File file) Returns a new request body that transmits the content of file.
static RequestBody	create(MediaType contentType, String content) Returns a new request body that transmits content.
abstract void	writeTo(okio.BufferedSink sink) Writes the content of this request to sink.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RequestBody

public RequestBody()

Method Detail

contentType

@Nullable
public abstract MediaType contentType()

Returns the Content-Type header for this body.

contentLength

public long contentLength()
                   throws IOException

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

Throws:

IOException

writeTo

public abstract void writeTo(okio.BufferedSink sink)
                      throws IOException

Writes the content of this request to sink.

Throws:

IOException

create

public static RequestBody create(@Nullable
                                 MediaType contentType,
                                 String content)

Returns a new request body that transmits content. If contentType is non-null and lacks a charset, this will use UTF-8.

create

public static RequestBody create(@Nullable
                                 MediaType contentType,
                                 okio.ByteString content)

Returns a new request body that transmits content.

create

public static RequestBody create(@Nullable
                                 MediaType contentType,
                                 byte[] content)

Returns a new request body that transmits content.

create

public static RequestBody create(@Nullable
                                 MediaType contentType,
                                 byte[] content,
                                 int offset,
                                 int byteCount)

Returns a new request body that transmits content.

create

public static RequestBody create(@Nullable
                                 MediaType contentType,
                                 File file)

Returns a new request body that transmits the content of file.