retrofit2.http

Annotation Type Headers

@Documented
 @Target(value=METHOD)
 @Retention(value=RUNTIME)
public @interface Headers

Adds headers literally supplied in the value.

 @Headers("Cache-Control: max-age=640000")
 @GET("/")
 ...

 @Headers({
   "X-Foo: Bar",
   "X-Ping: Pong"
 })
 @GET("/")
 ...
 

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

@Headers({ "X-Foo: Bar", "X-Ping: Pong" }, allowUnsafeNonAsciiValues=true) @GET("/")

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

See Also:

Header, 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