retrofit2.http

Annotation Type Part

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

Denotes a single part of a multi-part request.

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

• If the type is RequestBody the value will be used directly with its content type.
• Other object types will be converted to an appropriate representation by using a converter.

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

 @Multipart
 @POST("/")
 Call<ResponseBody> example(
     @Part("description") String description,
     @Part(value = "image", encoding = "8-bit") RequestBody image);
 

Part parameters may not be null.

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	value

Optional Element Summary

Optional Elements

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

Element Detail

value

public abstract String value

encoding

public abstract String encoding

The Content-Transfer-Encoding of this part.

Default:

"binary"