org.androidannotations.rest.spring.annotations

Annotation Type Part

@Retention(value=CLASS)
 @Target(value=PARAMETER)
public @interface Part

This annotation can be used to add a multi-part parameter to the POST, PUT or PATCH request from a method parameter. The annotation value should be the name of the multi-part parameter, if not specified, the method parameter name will be used as the name of the multi-part parameter. This annotation only can be used with a method which be annotated with Post, Put or Patch. To use this annotation, you must add FormHttpMessageConverter to the list of converters.

Example :

 @Rest(rootUrl = "http://myserver", converters = FormHttpMessageConverter.class)
 public interface RestClient {

        @Post("/events/{id}")
        EventList addEvent(String id, @Part FileResource image);
 }
 

See Also:

Rest, Post, Put, Patch, Field, Body

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	value Name of the post parameter.

Element Detail

value

public abstract String value

Name of the post parameter.

Returns:

name of the parameter

Default:

""