ktor-server-test-host/io.ktor.server.testing/TestApplicationRequest

TestApplicationRequest

class TestApplicationRequest(call: TestApplicationCall, closeRequest: Boolean, method: HttpMethod = HttpMethod.Get, uri: String = "/", port: Int? = null, version: String = "HTTP/1.1") : BaseApplicationRequest, CoroutineScope

A test application request

Constructors

TestApplicationRequest

constructor(call: TestApplicationCall, closeRequest: Boolean, method: HttpMethod = HttpMethod.Get, uri: String = "/", port: Int? = null, version: String = "HTTP/1.1")

Properties

var bodyChannel: ByteReadChannel

Request body channel.

override val call: PipelineCall

open override val cookies: RequestCookies

coroutineContext

open override val coroutineContext: CoroutineContext

override val headers: Headers

open override val local: RequestConnectionPoint

var method: HttpMethod

HTTP method to be sent or executed

open override val pipeline: ApplicationReceivePipeline

var port: Int?

(Optional) HTTP port to send request to

var protocol: String

HTTP protocol to be used or was used

queryParameters

open override val queryParameters: Parameters

rawQueryParameters

open override val rawQueryParameters: Parameters

var uri: String

HTTP url to sent request to or was sent to

var version: String

HTTP version to sent or executed

Functions

fun addHeader(name: String, value: String)

Adds an HTTP request header.

override fun receiveChannel(): ByteReadChannel

fun TestApplicationRequest.setBody(value: ByteReadPacket)

Set HTTP request body from ByteReadPacket

fun TestApplicationRequest.setBody(value: ByteArray)

Sets an HTTP request body bytes.

fun TestApplicationRequest.setBody(value: String)

Sets an HTTP request body text content.

fun TestApplicationRequest.setBody(boundary: String, parts: List<PartData>)

Sets a multipart HTTP request body.

override fun setHeader(name: String, values: List<String>?)

setReceiveChannel

override fun setReceiveChannel(channel: ByteReadChannel)