@Target([AnnotationTarget.VALUE_PARAMETER]) class Path
Named replacement in a URL path segment. Values are converted to strings using (or Object#toString(), if no matching string converter is installed) and then URL encoded.
Simple example:
@GET("/image/{id}")
Call<ResponseBody> example(@Path("id") int id);
foo.example(1) yields /image/1.
Values are URL encoded by default. Disable with encoded=true.
@GET("/user/{name}")
Call<ResponseBody> encoded(@Path("name") String name);
@GET("/user/{name}")
Call<ResponseBody> notEncoded(@Path(value="name", encoded=true) String name);
foo.encoded("John+Doe") yields /user/John%2BDoe whereas foo.notEncoded("John+Doe") yields /user/John+Doe.
Path parameters may not be null.
Path(value: String, encoded: Boolean)
Named replacement in a URL path segment. Values are converted to strings using |
val encoded: Boolean
Specifies whether the argument value to the annotated method parameter is already URL encoded. |
|
val value: String |