NollyAPI/com.thenolle.api.nollyapi.util.web.context/WebContext

WebContext

class WebContext(val call: ApplicationCall)

Context class for handling HTTP requests in Ktor.

This class provides utility methods to access parameters, headers, cookies, and other data from HTTP requests. It also provides methods for responding to requests with JSON or text responses.

Constructors

WebContext

constructor(call: ApplicationCall)

Properties

call

val call: ApplicationCall

The ApplicationCall instance representing the HTTP request.

Functions

body

inline suspend fun <T> body(): T

Parses the request body into an object of type T.

fun cookie(key: String): String?

Retrieves a cookie value by key.

fun cookie(key: String, defaultValue: String? = null): String?

Retrieves a cookie value by key with a default value if not found.

fun cookies(): Map<String, String>

Retrieves all cookies as a map of key-value pairs.

error

suspend fun error(message: String, status: HttpStatusCode = HttpStatusCode.BadRequest)

Sends an error message in JSON format.

header

fun header(key: String): String?

Retrieves a header from the request by key.

isDelete

fun isDelete(): Boolean

Checks if the HTTP method is DELETE.

isGet

fun isGet(): Boolean

Checks if the HTTP method is GET.

isHead

fun isHead(): Boolean

Checks if the HTTP method is HEAD.

isOptions

fun isOptions(): Boolean

Checks if the HTTP method is OPTIONS.

isPatch

fun isPatch(): Boolean

Checks if the HTTP method is PATCH.

isPost

fun isPost(): Boolean

Checks if the HTTP method is POST.

isPut

fun isPut(): Boolean

Checks if the HTTP method is PUT.

json

suspend fun json(data: Any?, status: HttpStatusCode = HttpStatusCode.OK)

Sends a JSON response with the provided data.

suspend fun ok()

Sends an "OK" response with a status code of 200.

param

fun param(key: String): String?

Retrieves a parameter from the request by key.

path

fun path(index: Int): String?

Retrieves a specific path segment by index.

send

inline suspend fun <T : Any> send(data: T, status: HttpStatusCode = HttpStatusCode.OK)

Sends the specified data as a JSON response with a specified status code.