okhttp3

Class MultipartBody

java.lang.Object

okhttp3.RequestBody

okhttp3.MultipartBody

public final class MultipartBody
extends RequestBody

An RFC 2387-compliant request body.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MultipartBody.Builder
static class	MultipartBody.Part

Field Summary

Fields

Modifier and Type	Field and Description
static MediaType	ALTERNATIVE The "multipart/alternative" type is syntactically identical to "multipart/mixed", but the semantics are different.
static MediaType	DIGEST This type is syntactically identical to "multipart/mixed", but the semantics are different.
static MediaType	FORM The media-type multipart/form-data follows the rules of all multipart MIME data streams as outlined in RFC 2046.
static MediaType	MIXED The "mixed" subtype of "multipart" is intended for use when the body parts are independent and need to be bundled in a particular order.
static MediaType	PARALLEL This type is syntactically identical to "multipart/mixed", but the semantics are different.

Method Summary

Methods

Modifier and Type	Method and Description
String	boundary()
long	contentLength() Returns the number of bytes that will be written to out in a call to RequestBody.writeTo(okio.BufferedSink), or -1 if that count is unknown.
MediaType	contentType() A combination of type() and boundary().
MultipartBody.Part	part(int index)
List<MultipartBody.Part>	parts()
int	size() The number of parts in this multipart body.
MediaType	type()
void	writeTo(okio.BufferedSink sink) Writes the content of this request to out.

Methods inherited from class okhttp3.RequestBody

create, create, create, create, create

Methods inherited from class java.lang.Object

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

Field Detail

MIXED

public static final MediaType MIXED

The "mixed" subtype of "multipart" is intended for use when the body parts are independent and need to be bundled in a particular order. Any "multipart" subtypes that an implementation does not recognize must be treated as being of subtype "mixed".

ALTERNATIVE

public static final MediaType ALTERNATIVE

The "multipart/alternative" type is syntactically identical to "multipart/mixed", but the semantics are different. In particular, each of the body parts is an "alternative" version of the same information.

DIGEST

public static final MediaType DIGEST

This type is syntactically identical to "multipart/mixed", but the semantics are different. In particular, in a digest, the default Content-Type value for a body part is changed from "text/plain" to "message/rfc822".

PARALLEL

public static final MediaType PARALLEL

This type is syntactically identical to "multipart/mixed", but the semantics are different. In particular, in a parallel entity, the order of body parts is not significant.

FORM

public static final MediaType FORM

The media-type multipart/form-data follows the rules of all multipart MIME data streams as outlined in RFC 2046. In forms, there are a series of fields to be supplied by the user who fills out the form. Each field has a name. Within a given form, the names are unique.

Method Detail

type

public MediaType type()

boundary

public String boundary()

size

public int size()

The number of parts in this multipart body.

parts

public List<MultipartBody.Part> parts()

part

public MultipartBody.Part part(int index)

contentType

public MediaType contentType()

A combination of type() and boundary().

Specified by:

contentType in class RequestBody

contentLength

public long contentLength()
                   throws IOException

Description copied from class: RequestBody

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

Overrides:

contentLength in class RequestBody

Throws:

IOException

writeTo

public void writeTo(okio.BufferedSink sink)
             throws IOException

Description copied from class: RequestBody

Writes the content of this request to out.

Specified by:

writeTo in class RequestBody

Throws:

IOException