ktor-server-core/io.ktor.server.request/ApplicationRequest

ApplicationRequest

interface ApplicationRequest

A client's request. To learn how to handle incoming requests, see Handling requests.

See also

io.ktor.server.application.ApplicationCall

io.ktor.server.response.ApplicationResponse

Functions

abstract fun receiveChannel(): <ERROR CLASS>

Receives a raw body payload as a channel.

Properties

abstract val call: ApplicationCall

An ApplicationCall instance this ApplicationRequest is attached to.

abstract val cookies: RequestCookies

Provides access to cookies for this request.

abstract val headers: <ERROR CLASS>

Provides access to headers for the current request. You can also get access to specific headers using dedicated extension functions, such as acceptEncoding, contentType, cacheControl, and so on.

abstract val local: <ERROR CLASS>

Provides access to connection details such as a host name, port, scheme, and so on. To get information about a request passed through an HTTP proxy or a load balancer, install the ForwardedHeaders/XForwardedHeader plugin and use the origin property.

abstract val pipeline: ApplicationReceivePipeline

A pipeline for receiving content.

queryParameters

abstract val queryParameters: <ERROR CLASS>

Provides access to decoded parameters of a URL query string.

rawQueryParameters

abstract val rawQueryParameters: <ERROR CLASS>

Provides access to parameters of a URL query string.

Inheritors

RoutingApplicationRequest

Extensions

fun ApplicationRequest.accept(): String?

Get a request's Accept header value.

fun ApplicationRequest.acceptCharset(): String?

Gets a request's Accept-Charset header value.

acceptCharsetItems

fun ApplicationRequest.acceptCharsetItems(): List<<ERROR CLASS>>

Gets the Accept-Charset header charsets sorted according to their qualities.

fun ApplicationRequest.acceptEncoding(): String?

Gets a request's Accept-Encoding header value.

acceptEncodingItems

fun ApplicationRequest.acceptEncodingItems(): List<<ERROR CLASS>>

Gets the Accept-Encoding header encoding types sorted according to their qualities.

fun ApplicationRequest.acceptItems(): List<<ERROR CLASS>>

Gets the Accept header content types sorted according to their qualities.

fun ApplicationRequest.acceptLanguage(): String?

Gets a request's Accept-Language header value.

acceptLanguageItems

fun ApplicationRequest.acceptLanguageItems(): List<<ERROR CLASS>>

Gets the Accept-Language header languages sorted according to their qualities.

fun ApplicationRequest.authorization(): String?

Get a request's Authorization header value.

fun ApplicationRequest.cacheControl(): String?

Gets a request's Cache-Control header value.

fun ApplicationRequest.contentCharset(): <ERROR CLASS>?

Gets a request's charset.

fun ApplicationRequest.contentLength(): Long?

Gets a request's Content-Length header value.

fun ApplicationRequest.contentType(): <ERROR CLASS>

Gets a request's content type or returns ContentType.Any.

fun ApplicationRequest.document(): String

A document name is a substring after the last slash but before a query string.

encodeParameters

fun ApplicationRequest.encodeParameters(parameters: <ERROR CLASS>): <ERROR CLASS>

Internal helper function to encode raw parameters. Should not be used directly.

fun ApplicationRequest.header(name: String): String?

Gets the first value of a name header or returns null if missing.

fun ApplicationRequest.host(): String

Gets a request's host value without a port.

val ApplicationRequest.httpMethod: <ERROR CLASS>

Gets a request HTTP method possibly overridden using the X-Http-Method-Override header.

val ApplicationRequest.httpVersion: String

Gets a request's HTTP version.

fun ApplicationRequest.isChunked(): Boolean

Checks whether a request's body is chunk-encoded.

fun ApplicationRequest.isMultipart(): Boolean

Checks whether a request body is multipart-encoded.

fun ApplicationRequest.location(): String?

Get a request's Location header value.

val ApplicationRequest.origin: <ERROR CLASS>

Represents request and connection parameters possibly overridden via https headers. By default it fallbacks to ApplicationRequest.local

fun ApplicationRequest.path(): String

Get a request's URL path without a query string.

fun ApplicationRequest.port(): Int

Gets a request's port extracted from the Host header value.

fun ApplicationRequest.queryString(): String

Gets a request's query string or returns an empty string if missing.

fun ApplicationRequest.ranges(): <ERROR CLASS>?

Gets ranges parsed from a request's Range header value.

fun ApplicationRequest.toLogString(): String

Generates a string representing this ApplicationRequest suitable for logging

val ApplicationRequest.uri: String

Gets a request's URI, including a query string.

fun ApplicationRequest.userAgent(): String?

Gets a request's User-Agent header value.