kvision-rest/io.kvision.rest

Package-level declarations

RESTful API client with support for type-safe connectivity.

Types

class BadGateway(val url: String, val method: HttpMethod, message: String, val response: Response? = null) : RemoteRequestException

BadRequest

class BadRequest(val url: String, val method: HttpMethod, message: String, val response: Response? = null) : RemoteRequestException

Forbidden

class Forbidden(val url: String, val method: HttpMethod, message: String, val response: Response? = null) : RemoteRequestException

HttpMethod

enum HttpMethod : Enum<HttpMethod>

HTTP methods.

NotAllowed

class NotAllowed(val url: String, val method: HttpMethod, message: String, val response: Response? = null) : RemoteRequestException

NotFound

class NotFound(val url: String, val method: HttpMethod, message: String, val response: Response? = null) : RemoteRequestException

NotImplemented

class NotImplemented(val url: String, val method: HttpMethod, message: String, val response: Response? = null) : RemoteRequestException

RemoteRequestException

open class RemoteRequestException(val code: Short, val url: String, val method: HttpMethod, message: String, val response: Response? = null) : Exception

ResponseBodyType

enum ResponseBodyType : Enum<ResponseBodyType>

HTTP response body types.

RestClient

open class RestClient(block: RestClientConfig.() -> Unit = {})

A HTTP REST client

RestClientConfig

class RestClientConfig

REST Client configuration

RestRequestConfig

class RestRequestConfig<T : Any, V : Any>

REST request configuration

RestResponse

data class RestResponse<T>(val data: T, val textStatus: String, val response: Response)

A response wrapper

ServerError

class ServerError(val url: String, val method: HttpMethod, message: String, val response: Response? = null) : RemoteRequestException

ServiceUnavailable

class ServiceUnavailable(val url: String, val method: HttpMethod, message: String, val response: Response? = null) : RemoteRequestException

Unauthorized

class Unauthorized(val url: String, val method: HttpMethod, message: String, val response: Response? = null) : RemoteRequestException

XHRError

class XHRError(val url: String, val method: HttpMethod, message: String, val response: Response? = null) : RemoteRequestException

Code 0 does not represent any http status, it represent XHR error (e.g. network error, CORS failure).

Properties

HTTP_BAD_GATEWAY

const val HTTP_BAD_GATEWAY: Short = 502

HTTP_BAD_REQUEST

const val HTTP_BAD_REQUEST: Short = 400

HTTP_FORBIDDEN

const val HTTP_FORBIDDEN: Short = 403

HTTP_NO_CONTENT

const val HTTP_NO_CONTENT: Short = 204

HTTP_NOT_ALLOWED

const val HTTP_NOT_ALLOWED: Short = 405

HTTP_NOT_FOUND

const val HTTP_NOT_FOUND: Short = 404

HTTP_NOT_IMPLEMENTED

const val HTTP_NOT_IMPLEMENTED: Short = 501

HTTP_SERVER_ERROR

const val HTTP_SERVER_ERROR: Short = 500

HTTP_SERVICE_UNAVAILABLE

const val HTTP_SERVICE_UNAVAILABLE: Short = 503

HTTP_UNAUTHORIZED

const val HTTP_UNAUTHORIZED: Short = 401

XHR_ERROR

const val XHR_ERROR: Short = 0

Functions

call

inline fun <T : Any> RestClient.call(url: String, crossinline block: RestRequestConfig<T, dynamic>.() -> Unit = {}): Promise<T>

inline fun <T : Any, V : Any> RestClient.call(url: String, data: V, crossinline block: RestRequestConfig<T, V>.() -> Unit = {}): Promise<T>

Makes a http request to the server, returning data directly.

callDynamic

fun RestClient.callDynamic(url: String, block: RestRequestConfig<dynamic, dynamic>.() -> Unit = {}): Promise<dynamic>

inline fun <V : Any> RestClient.callDynamic(url: String, data: V, crossinline block: RestRequestConfig<dynamic, V>.() -> Unit = {}): Promise<dynamic>

Makes a http request to the server, returning data directly.

post

inline fun <T : Any, V : Any> RestClient.post(url: String, data: V, crossinline block: RestRequestConfig<T, V>.() -> Unit = {}): Promise<T>

Makes a http POST request to the server, returning data directly.

postDynamic

inline fun <V : Any> RestClient.postDynamic(url: String, data: V, crossinline block: RestRequestConfig<dynamic, V>.() -> Unit = {}): Promise<dynamic>

Makes a http POST request to the server, returning data directly.

request

inline fun <T : Any> RestClient.request(url: String, crossinline block: RestRequestConfig<T, dynamic>.() -> Unit = {}): Promise<RestResponse<T>>

inline fun <T : Any, V : Any> RestClient.request(url: String, data: V, crossinline block: RestRequestConfig<T, V>.() -> Unit = {}): Promise<RestResponse<T>>

Makes a http request to the server, returning the response object.

requestDynamic

fun RestClient.requestDynamic(url: String, block: RestRequestConfig<dynamic, dynamic>.() -> Unit = {}): Promise<RestResponse<dynamic>>

inline fun <V : Any> RestClient.requestDynamic(url: String, data: V, crossinline block: RestRequestConfig<dynamic, V>.() -> Unit = {}): Promise<RestResponse<dynamic>>

Makes a http request to the server, returning the response object.