retrofit2.http

Annotation Type Header

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

Replaces the header with the value of its target.

 @GET("/")
 Call<ResponseBody> foo(@Header("Accept-Language") String lang);
 

Header parameters may be null which will omit them from the request. Passing a List or array will result in a header for each non-null item.

Parameter keys and values only allows ascii values by default. Specify allowUnsafeNonAsciiValues=true to change this behavior.

 @GET("/")
 Call<ResponseBody> foo(@Header("Accept-Language", allowUnsafeNonAsciiValues=true) String lang);
 

Note: Headers do not overwrite each other. All headers with the same name will be included in the request.

See Also:

Headers, HeaderMap

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
java.lang.String	value The query parameter name.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	allowUnsafeNonAsciiValues Specifies whether the parameter name and value are already URL encoded.

Element Detail

value

public abstract java.lang.String value

The query parameter name.

allowUnsafeNonAsciiValues

public abstract boolean allowUnsafeNonAsciiValues

Specifies whether the parameter name and value are already URL encoded.

Default:

false