retrofit.http

Annotation Type Retrofit.Part

@Documented
 @Target(value=PARAMETER)
 @Retention(value=RUNTIME)
public static @interface Retrofit.Part

Denotes a single part of a multi-part request.

 @Multipart @PUT(@Part)
 

The parameter type on which this annotation exists will be processed in one of three ways:

• If the type implements TypedOutput the headers and body will be used directly.
• If the type is String the value will also be used directly with a text/plain content type.
• Other object types will be converted to an appropriate representation by calling Converter.toBody(Object).

Values may be null which will omit them from the request body.

 @Multipart
 @POST("/")
 void example(@Part("description") String description,
              @Part("image") TypedFile image,
              ...
 );
 

Part parameters may not be null.

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
java.lang.String	value

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
java.lang.String	encoding The Content-Transfer-Encoding of this part.
java.lang.String	mimeType

Element Detail

value

public abstract java.lang.String value

encoding

public abstract java.lang.String encoding

The Content-Transfer-Encoding of this part.

Default:

"binary"

mimeType

public abstract java.lang.String mimeType

Default:

""