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

Response

class Response(source)

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

An empty successful response is automatically created and passed into an API via an ApiContext. Developers implementing an API endpoint should modify this response with code like the following:

@Api
fun demo(ctx: ApiContext) {
  ctx.res.setBodyText("This is how you send text back to the client")
}
Content copied to clipboard

See also

Constructors

Link copied to clipboard
constructor()

Properties

Link copied to clipboard
var body: ByteArray

The body payload to send back

Link copied to clipboard
var contentType: String?

The content type of the body, e.g. "image/jpeg" or "application/json". Can include parameters.

Link copied to clipboard
val headers: MutableMap<String, String>

Any additional headers to send back to the client.

Link copied to clipboard
var status: Int

Functions

Link copied to clipboard
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.

Link copied to clipboard
fun Response.setBodyText(text: String)

Convenience method for setting the body to a text value.