kobweb-api/com.varabyte.kobweb.api.http

Package-level declarations

Types

Body

class Body : ContentSource

The body of a request or response.

ContentDisposition

class ContentDisposition(val disposition: String, val parameters: Map<String, String> = mapOf())

Extra information about how content should be treated / displayed.

ContentSource

interface ContentSource

Interface for a body class that allows users to consume its body content.

HttpMethod

enum HttpMethod : Enum<HttpMethod>

Multipart

interface Multipart

Represents all relevant information associated with a multipart request.

MultipartScope

class MultipartScope

MutableRequest

class MutableRequest(val connection: Request.Connection, var method: HttpMethod, params: Map<String, String>, queryParams: Map<String, String>, headers: Map<String, List<String>>, cookies: Map<String, String>, var body: Body?, val data: MutableData = MutableData()) : Request

Request

interface Request

Information passed into an API endpoint from the client.

Response

class Response

Data to send back to the client after it makes a request to an API endpoint.

Functions

bytes

suspend fun ContentSource.bytes(limit: Int? = null): ByteArray

Convenience method to convert a body's content into a raw byte array.

fun Body.Companion.bytes(bytes: ByteArray, contentType: String = "application/octet-stream"): Body

forEachPart

suspend fun Multipart.forEachPart(autoClose: Boolean = true, block: suspend MultipartScope.(Multipart.Part) -> Unit)

A convenience method that wraps Multipart.readNextPart so you don't have to collect it yourself.

json

fun Body.Companion.json(text: String, contentType: String = "application/json"): Body

readBodyText

suspend fun Request.~~readBodyText~~(): String?

setAsRedirect

fun Response.setAsRedirect(newPath: String, status: Int = 307, isApiPath: Boolean = false)

Set this to a response that tells the client that the requested resource has moved to a new location.

setBodyText

fun Response.~~setBodyText~~(text: String)

Convenience method for setting the body to a text value.

stream

suspend fun ContentSource.stream(): InputStream

Convert this byte source into an InputStream.

fun Body.Companion.stream(inputStream: InputStream, contentType: String = "application/octet-stream"): Body

text

suspend fun ContentSource.text(charset: Charset = contentType.parseCharsetFromContentType(), limit: Int? = null): String

Convenience method to convert a body's content into a UTF-8 string.

fun Body.Companion.text(text: String, charset: Charset = Charsets.UTF_8, contentType: String = "text/plain; charset="): Body