Part

@Target([AnnotationTarget.VALUE_PARAMETER]) class Part

Denotes a single part of a multi-part request.

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

If the type is okhttp3.MultipartBody.Part the contents will be used directly. Omit the name from the annotation (i.e., @Part MultipartBody.Part part).
If the type is RequestBody the value will be used directly with its content type. Supply the part name in the annotation (e.g., @Part("foo") RequestBody foo).
Other object types will be converted to an appropriate representation by using . Supply the part name in the annotation (e.g., @Part("foo") Image photo).

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.

Constructors

<init>

Part(value: String, encoding: String)

Denotes a single part of a multi-part request.

Properties

encoding	`val encoding: String` The `Content-Transfer-Encoding` of this part.
value	`val value: String` The name of the part. Required for all parameter types except .