ktor-client-resources/io.ktor.client.plugins.resources

Package-level declarations

Types

Resources

object Resources : HttpClientPlugin<Resources.Configuration, Resources>

Adds support for type-safe requests using ResourcesCore.

Functions

delete

inline suspend fun <T : Any> HttpClient.delete(resource: T, builder: HttpRequestBuilder.() -> Unit = {}): HttpResponse

Executes a HttpClient DELETE request, with a URL built from resource and the information from the builder

get

inline suspend fun <T : Any> HttpClient.get(resource: T, builder: HttpRequestBuilder.() -> Unit = {}): HttpResponse

Executes a HttpClient GET request, with a URL built from resource and the information from the builder

head

inline suspend fun <T : Any> HttpClient.head(resource: T, builder: HttpRequestBuilder.() -> Unit = {}): HttpResponse

Executes a HttpClient HEAD request, with a URL built from resource and the information from the builder

href

inline fun <T : Any> HttpClient.href(resource: T): String

inline fun <T : Any> HttpClient.href(resource: T, urlBuilder: URLBuilder)

Constructs a URL for resource.

options

inline suspend fun <T : Any> HttpClient.options(resource: T, builder: HttpRequestBuilder.() -> Unit = {}): HttpResponse

Executes a HttpClient OPTIONS request, with a URL built from resource and the information from the builder

patch

inline suspend fun <T : Any> HttpClient.patch(resource: T, builder: HttpRequestBuilder.() -> Unit = {}): HttpResponse

Executes a HttpClient PATCH request, with a URL built from resource and the information from the builder

post

inline suspend fun <T : Any> HttpClient.post(resource: T, builder: HttpRequestBuilder.() -> Unit = {}): HttpResponse

Executes a HttpClient POST request, with a URL built from resource and the information from the builder

prepareDelete

inline suspend fun <T : Any> HttpClient.prepareDelete(resource: T, builder: HttpRequestBuilder.() -> Unit = {}): HttpStatement

Prepares a HttpClient DELETE request, with a URL built from resource and the information from the builder

prepareGet

inline suspend fun <T : Any> HttpClient.prepareGet(resource: T, builder: HttpRequestBuilder.() -> Unit = {}): HttpStatement

Prepares a HttpClient GET request, with a URL built from resource and the information from the builder

prepareHead

inline suspend fun <T : Any> HttpClient.prepareHead(resource: T, builder: HttpRequestBuilder.() -> Unit = {}): HttpStatement

Prepares a HttpClient HEAD request, with a URL built from resource and the information from the builder

prepareOptions

inline suspend fun <T : Any> HttpClient.prepareOptions(resource: T, builder: HttpRequestBuilder.() -> Unit = {}): HttpStatement

Prepares a HttpClient OPTIONS request, with a URL built from resource and the information from the builder

preparePatch

inline suspend fun <T : Any> HttpClient.preparePatch(resource: T, builder: HttpRequestBuilder.() -> Unit = {}): HttpStatement

Prepares a HttpClient PATCH request, with a URL built from resource and the information from the builder

preparePost

inline suspend fun <T : Any> HttpClient.preparePost(resource: T, builder: HttpRequestBuilder.() -> Unit = {}): HttpStatement

Prepares a HttpClient POST request, with a URL built from resource and the information from the builder

preparePut

inline suspend fun <T : Any> HttpClient.preparePut(resource: T, builder: HttpRequestBuilder.() -> Unit = {}): HttpStatement

Prepares a HttpClient PUT request, with a URL built from resource and the information from the builder

prepareRequest

inline suspend fun <T : Any> HttpClient.prepareRequest(resource: T, builder: HttpRequestBuilder.() -> Unit = {}): HttpStatement

Prepares a HttpClient request, with a URL built from resource and the information from the builder

put

inline suspend fun <T : Any> HttpClient.put(resource: T, builder: HttpRequestBuilder.() -> Unit = {}): HttpResponse

Executes a HttpClient PUT request, with a URL built from resource and the information from the builder

request

inline suspend fun <T : Any> HttpClient.request(resource: T, builder: HttpRequestBuilder.() -> Unit): HttpResponse

Executes a HttpClient request, with a URL built from resource and the information from the builder