Produces HTTP/2 push from server to client or sets HTTP/1.x hint header or does nothing (may call or not call block). Exact behaviour is up to engine implementation.

receive

inline suspend fun <T : Any> ApplicationCall.receive(): T

suspend fun <T : Any> ApplicationCall.receive(type: KClass<T>): T

suspend fun <T> ApplicationCall.receive(typeInfo: TypeInfo): T

Receives content for this request.

receiveChannel

inline suspend fun ApplicationCall.receiveChannel(): ByteReadChannel

Receives channel content for this call.

receiveMultipart

inline suspend fun ApplicationCall.receiveMultipart(): MultiPartData

Receives multipart data for this call.

receiveNullable

inline suspend fun <T> ApplicationCall.receiveNullable(): T?

suspend fun <T> ApplicationCall.receiveNullable(typeInfo: TypeInfo): T?

Receives content for this request.

receiveOrNull

inline suspend fun <T : Any> ApplicationCall.~~receiveOrNull~~(): T?

suspend fun <T : Any> ApplicationCall.~~receiveOrNull~~(typeInfo: TypeInfo): T?

suspend fun <T : Any> ApplicationCall.~~receiveOrNull~~(type: KClass<T>): T?

Receives content for this request.

receiveParameters

inline suspend fun ApplicationCall.receiveParameters(): Parameters

Receives form parameters for this call.

receiveStream

inline suspend fun ApplicationCall.receiveStream(): InputStream

Receives stream content for this call.

receiveText

inline suspend fun ApplicationCall.receiveText(): String

Receives incoming content for this call as String.

receiveType

var ApplicationCall.receiveType: TypeInfo

The TypeInfo recorded from the last call.receive() call.

resolveResource

fun ApplicationCall.resolveResource(path: String, resourcePackage: String? = null, classLoader: ClassLoader = application.environment.classLoader, mimeResolve: (String) -> ContentType = { ContentType.defaultForFileExtension(it) }): OutgoingContent?

respond

@JvmName(name = "respondWithType")

inline suspend fun <T : Any> ApplicationCall.respond(message: T)

Sends a message as a response.

suspend fun ApplicationCall.respond(message: Any?, messageType: TypeInfo)

Sends a message of type messageType as a response.

@JvmName(name = "respondWithType")

inline suspend fun <T : Any> ApplicationCall.respond(status: HttpStatusCode, message: T)

Sends a message as a response with the specified status code.

suspend fun ApplicationCall.respond(status: HttpStatusCode, message: Any?, messageType: TypeInfo)

Sends a message of type messageType as a response with the specified status code.

respondBytes

suspend fun ApplicationCall.respondBytes(contentType: ContentType? = null, status: HttpStatusCode? = null, provider: suspend () -> ByteArray)

Responds to a client with a raw bytes response, using the specified provider to build a byte array.

suspend fun ApplicationCall.respondBytes(bytes: ByteArray, contentType: ContentType? = null, status: HttpStatusCode? = null, configure: OutgoingContent.() -> Unit = {})

Responds to a client with a raw bytes response, using specified bytes.

respondBytesWriter

suspend fun ApplicationCall.respondBytesWriter(contentType: ContentType? = null, status: HttpStatusCode? = null, contentLength: Long? = null, producer: suspend ByteWriteChannel.() -> Unit)

Respond with a binary content producer.

respondFile

suspend fun ApplicationCall.respondFile(baseDir: File, fileName: String, configure: OutgoingContent.() -> Unit = {})

Responds to a client with a contents of a file with the name fileName in the baseDir folder

suspend fun ApplicationCall.respondFile(file: File, configure: OutgoingContent.() -> Unit = {})

Responds to a client with a contents of a file

respondNullable

inline suspend fun <T> ApplicationCall.respondNullable(message: T)

Sends a message as a response.

inline suspend fun <T> ApplicationCall.respondNullable(status: HttpStatusCode, message: T)

Sends a message as a response with the specified status code.

respondOutputStream

suspend fun ApplicationCall.respondOutputStream(contentType: ContentType? = null, status: HttpStatusCode? = null, producer: suspend OutputStream.() -> Unit)

suspend fun ApplicationCall.respondOutputStream(contentType: ContentType? = null, status: HttpStatusCode? = null, contentLength: Long? = null, producer: suspend OutputStream.() -> Unit)

Respond with binary content producer.

respondRedirect

suspend fun ApplicationCall.respondRedirect(url: String, permanent: Boolean = false)

suspend fun ApplicationCall.respondRedirect(url: Url, permanent: Boolean = false)

Responds to a client with a 301 Moved Permanently or 302 Found redirect.

inline suspend fun ApplicationCall.respondRedirect(permanent: Boolean = false, block: URLBuilder.() -> Unit)

Responds to a client with a 301 Moved Permanently or 302 Found redirect. Unlike the other respondRedirect, it provides a way to build a URL based on current call using the block function.

respondText

suspend fun ApplicationCall.respondText(text: String, contentType: ContentType? = null, status: HttpStatusCode? = null, configure: OutgoingContent.() -> Unit = {})

Responds to a client with a plain text response.

suspend fun ApplicationCall.respondText(contentType: ContentType? = null, status: HttpStatusCode? = null, provider: suspend () -> String)

Responds to a client with a plain text response, using the specified provider to build a text.

respondTextWriter

suspend fun ApplicationCall.respondTextWriter(contentType: ContentType? = null, status: HttpStatusCode? = null, writer: suspend Writer.() -> Unit)

suspend fun ApplicationCall.respondTextWriter(contentType: ContentType? = null, status: HttpStatusCode? = null, contentLength: Long? = null, writer: suspend Writer.() -> Unit)

Respond with text content writer.

url

inline fun ApplicationCall.url(block: URLBuilder.() -> Unit = {}): String

Creates an url using current call's schema, path and parameters as initial and then invokes block function on the url builder so amend parameters

ApplicationCall

See also

Properties

Inheritors

Extensions