retrofit.http

Annotation Type Field

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

Named pair for a form-encoded request.

Values are converted to strings using String.valueOf(Object) and then form URL encoded. null values are ignored. Passing a List or array will result in a field pair for each non-null item.

Simple Example:

 @FormUrlEncoded
 @POST("/")
 void example(@Field("name") String name, @Field("occupation") String occupation);
 }
 

Calling with foo.example("Bob Smith", "President") yields a request body of name=Bob+Smith&occupation=President.

Array Example:

 @FormUrlEncoded
 @POST("/list")
 void example(@Field("name") String... names);
 

Calling with foo.example("Bob Smith", "Jane Doe") yields a request body of name=Bob+Smith&name=Jane+Doe.

See Also:

FormUrlEncoded, FieldMap

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
boolean	encodeName Specifies whether value() is URL encoded.
boolean	encodeValue Specifies whether the argument value to the annotated method parameter is URL encoded.

Element Detail

value

public abstract String value

encodeName

public abstract boolean encodeName

Specifies whether value() is URL encoded.

Default:

true

encodeValue

public abstract boolean encodeValue

Specifies whether the argument value to the annotated method parameter is URL encoded.

Default:

true