Package de.jensklingenberg.ktorfit.http

Types

Body

@Target(allowedTargets = [AnnotationTarget.VALUE_PARAMETER])

annotation class Body

DELETE

@Target(allowedTargets = [AnnotationTarget.FUNCTION])

annotation class DELETE(value: String)

Field

@Target(allowedTargets = [AnnotationTarget.VALUE_PARAMETER])

annotation class Field(value: String, encoded: Boolean)

FieldMap

@Target(allowedTargets = [AnnotationTarget.VALUE_PARAMETER])

annotation class FieldMap(encoded: Boolean)

FormUrlEncoded

@Target(allowedTargets = [AnnotationTarget.FUNCTION])

annotation class FormUrlEncoded

A function that is annotated with his, will have the header application/x-www-form-urlencoded added to the request

GET

@Target(allowedTargets = [AnnotationTarget.FUNCTION])

annotation class GET(value: String)

Make a GET request. if value is empty, you need to have a paramter with Url

HEAD

@Target(allowedTargets = [AnnotationTarget.FUNCTION])

annotation class HEAD(value: String)

Make a GET request.

Header

@Target(allowedTargets = [AnnotationTarget.VALUE_PARAMETER])

annotation class Header(value: String)

HeaderMap

@Target(allowedTargets = [AnnotationTarget.VALUE_PARAMETER])

annotation class HeaderMap

Headers

@Target(allowedTargets = [AnnotationTarget.FUNCTION])

annotation class Headers(value: Array<String>)

HTTP

@Target(allowedTargets = [AnnotationTarget.FUNCTION])

annotation class HTTP(method: String, path: String, hasBody: Boolean)

Make a GET request.

Multipart

@Target(allowedTargets = [AnnotationTarget.FUNCTION])

annotation class Multipart

OPTIONS

@Target(allowedTargets = [AnnotationTarget.FUNCTION])

annotation class OPTIONS(value: String)

Make an OPTIONS request.

Part

@Target(allowedTargets = [AnnotationTarget.VALUE_PARAMETER])

annotation class Part(value: String)

sTRING OR List< PartData> /**

PartMap

@Target(allowedTargets = [AnnotationTarget.VALUE_PARAMETER])

annotation class PartMap(encoding: String)

If the type is List the value will be used directly with its content type.

PATCH

@Target(allowedTargets = [AnnotationTarget.FUNCTION])

annotation class PATCH(value: String)

Path

@Target(allowedTargets = [AnnotationTarget.VALUE_PARAMETER])

annotation class Path(value: String, encoded: Boolean)

This can be set if you have parts in your URL that want to dynamically replaced

POST

@Target(allowedTargets = [AnnotationTarget.FUNCTION])

annotation class POST(value: String)

PUT

@Target(allowedTargets = [AnnotationTarget.FUNCTION])

annotation class PUT(value: String)

Query

@Target(allowedTargets = [AnnotationTarget.VALUE_PARAMETER])

annotation class Query(value: String, encoded: Boolean)

QueryMap

@Target(allowedTargets = [AnnotationTarget.VALUE_PARAMETER])

annotation class QueryMap(encoded: Boolean)

QueryName

@Target(allowedTargets = [AnnotationTarget.VALUE_PARAMETER])

annotation class QueryName(encoded: Boolean)

ReqBuilder

@Target(allowedTargets = [AnnotationTarget.VALUE_PARAMETER])

annotation class ReqBuilder

This can be used to add additional configurations to a request the parameter type has to be HttpRequestBuilder.() -> Unit

Streaming

@Target(allowedTargets = [AnnotationTarget.FUNCTION])

annotation class Streaming

Url

@Target(allowedTargets = [AnnotationTarget.VALUE_PARAMETER])

annotation class Url


@GET
Call<ResponseBody> list(@Url String url);