Package io.ktor.request
Types
open class ApplicationReceivePipeline : Pipeline for processing incoming content |
|
class ApplicationReceiveRequest Represents a subject for ApplicationReceivePipeline |
|
interface ApplicationRequest Represents client’s request |
|
open class RequestCookies Server request’s cookies |
Exceptions
class RequestAlreadyConsumedException : IllegalStateException Thrown when a request body has been already received. Usually it is caused by double ApplicationCall.receive invocation. |
Type Aliases
typealias ContentTransformationException = ContentTransformationException Thrown when content cannot be transformed to the desired type. |
Properties
val ApplicationRequest.httpMethod: HttpMethod Returns request HTTP method possibly overridden via header X-Http-Method-Override |
|
val ApplicationRequest.httpVersion: String Request’s HTTP version |
|
val ApplicationRequest.uri: String Request’s URI (including query string) |
Functions
fun ApplicationRequest.accept(): String? Request’s |
|
fun ApplicationRequest.acceptCharset(): String? Request’s |
|
fun ApplicationRequest.acceptCharsetItems(): List<HeaderValue> Parsed and sorted request’s |
|
fun ApplicationRequest.acceptEncoding(): String? Request’s |
|
fun ApplicationRequest.acceptEncodingItems(): List<HeaderValue> Parsed and sorted request’s |
|
fun ApplicationRequest.acceptItems(): List<HeaderValue> Parsed request’s |
|
fun ApplicationRequest.acceptLanguage(): String? Request’s |
|
fun ApplicationRequest.acceptLanguageItems(): List<HeaderValue> Parsed and sorted request’s |
|
fun ApplicationRequest.authorization(): String? Request authorization header value |
|
fun ApplicationRequest.cacheControl(): String? Request’s |
|
fun ApplicationRequest.contentCharset(): Charset? Request’s charset |
|
fun ApplicationRequest.contentType(): ContentType Request’s content type or |
|
fun ApplicationRequest.document(): String Request’s document name (substring after the last slash but before query string) |
|
fun ApplicationRequest.header(name: String): String? First header value for header with name or |
|
fun ApplicationRequest.host(): String Request’s host without port |
|
fun ApplicationRequest.isChunked(): Boolean Check if request’s body is chunk-encoded |
|
fun ApplicationRequest.isMultipart(): Boolean Check if request body is multipart-encoded |
|
fun ApplicationRequest.location(): String? Request’s |
|
fun ApplicationRequest.path(): String Request’s path without query string |
|
fun ApplicationRequest.port(): Int Request’s port extracted from |
|
fun ApplicationRequest.queryString(): String Request’s query string or empty string if missing |
|
fun ApplicationRequest.ranges(): RangesSpecifier? Parsed request’s |
|
suspend fun <T : Any> ApplicationCall.receive(): T suspend fun <T : Any> ApplicationCall.receive( suspend fun <T : Any> ApplicationCall.receive(type: KType): T Receives content for this request. |
|
suspend fun ApplicationCall.receiveChannel(): ByteReadChannel Receives channel content for this call. |
|
suspend fun ApplicationCall.receiveMultipart(): MultiPartData Receives multipart data for this call. |
|
suspend fun <T : Any> ApplicationCall.receiveOrNull(): T? suspend fun <T : Any> ApplicationCall.receiveOrNull( suspend fun <T : Any> ApplicationCall.receiveOrNull( Receives content for this request. |
|
suspend fun ApplicationCall.receiveParameters(): Parameters Receives form parameters for this call. |
|
suspend fun ApplicationCall.receiveStream(): InputStream Receives stream content for this call. |
|
suspend fun ApplicationCall.receiveText(): String Receives incoming content for this call as String. |
|
fun ApplicationRequest.userAgent(): String? Request’s |