Package de.jensklingenberg.ktorfit.http

Types

Body

@Target(allowedTargets = [AnnotationTarget.VALUE_PARAMETER])

annotation class Body

Use this to upload data in an HTTP Body @POST("createIssue") fun upload(@Body issue: Issue)

DELETE

@Target(allowedTargets = [AnnotationTarget.FUNCTION])

annotation class DELETE(value: String)

Make a DELETE request.

Field

@Target(allowedTargets = [AnnotationTarget.VALUE_PARAMETER])

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

Needs to be used in combination with FormUrlEncoded

FieldMap

@Target(allowedTargets = [AnnotationTarget.VALUE_PARAMETER])

annotation class FieldMap(encoded: Boolean)

Needs to be used in combination with FormUrlEncoded

FormUrlEncoded

@Target(allowedTargets = [AnnotationTarget.FUNCTION])

annotation class FormUrlEncoded

A function that is annotated with this, will have the header application/x-www-form-urlencoded added to the request. Needed to use @Field @FieldMap

GET

@Target(allowedTargets = [AnnotationTarget.FUNCTION])

annotation class GET(value: String)

Make a GET request.

HEAD

@Target(allowedTargets = [AnnotationTarget.FUNCTION])

annotation class HEAD(value: String)

Make a HEAD request.

Header

@Target(allowedTargets = [AnnotationTarget.VALUE_PARAMETER])

annotation class Header(value: String)

Add a header to a request

HeaderMap

@Target(allowedTargets = [AnnotationTarget.VALUE_PARAMETER])

annotation class HeaderMap

Add headers to a request

Headers

@Target(allowedTargets = [AnnotationTarget.FUNCTION])

annotation class Headers(value: String)

Add headers to a request

HTTP

@Target(allowedTargets = [AnnotationTarget.FUNCTION])

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

Make a request with a custom HTTP method.

Multipart

@Target(allowedTargets = [AnnotationTarget.FUNCTION])

annotation class Multipart

Send multipart data

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)

Make a PATCH request.

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)

Make a POST request.

PUT

@Target(allowedTargets = [AnnotationTarget.FUNCTION])

annotation class PUT(value: String)

Make a PUT request.

Query

@Target(allowedTargets = [AnnotationTarget.VALUE_PARAMETER])

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

Used for query parameters

QueryMap

@Target(allowedTargets = [AnnotationTarget.VALUE_PARAMETER])

annotation class QueryMap(encoded: Boolean)

Used for query parameters

QueryName

@Target(allowedTargets = [AnnotationTarget.VALUE_PARAMETER])

annotation class QueryName(encoded: Boolean)

Used for query parameters

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()