kord-rest/dev.kord.rest.request

Package-level declarations

Types

data class HttpStatus(val code: Int, val message: String)

Represents an HTTP status code and description.

class JsonRequest(val route: Route<R>, val routeParams: Map<Route.Key, String>, val parameters: StringValues, val headers: StringValues, val body: RequestBody?, baseUrl: String = Route.baseUrl) : Request<B, R>

KtorRequestException

class KtorRequestException(val httpResponse: HttpResponse, val request: Request<*, *>, discordError: DiscordErrorResponse?) : RestRequestException

Implementation of the RestRequestException for RestServices using Ktor.

KtorRequestHandler

class KtorRequestHandler(client: HttpClient, requestRateLimiter: RequestRateLimiter = ExclusionRequestRateLimiter(), clock: Clock = Clock.System, parser: Json = jsonDefault, val token: String) : RequestHandler

A RequestHandler that uses ktor's HttpClient to execute requests and accepts a requestRateLimiter to schedule requests.

MultipartRequest

class MultipartRequest(val route: Route<R>, val routeParams: Map<Route.Key, String>, val parameters: StringValues, val headers: StringValues, val body: RequestBody?, val files: List<NamedFile> = emptyList(), baseUrl: String = Route.baseUrl) : Request<B, R>

Request

sealed class Request

RequestBody

data class RequestBody<T : Any>(val strategy: SerializationStrategy<T>, val body: T)

RequestBuilder

class RequestBuilder<T>(val route: Route<T>, keySize: Int = 2)

RequestHandler

interface RequestHandler

Handles Discord API requests.

RequestIdentifier

sealed class RequestIdentifier

A 'per-route' identifier for rate limiting purposes.

RestRequestException

abstract class RestRequestException(val request: Request<*, *>, val status: HttpStatus, val error: DiscordErrorResponse? = null) : RequestException

Signals that an error related to interactions with the REST API occurred.

StackTraceRecoveringKtorRequestHandler

class StackTraceRecoveringKtorRequestHandler(delegate: KtorRequestHandler) : RequestHandler

Extension of KtorRequestHandler which tries to recover stack trace information lost through Ktor's io.ktor.util.pipeline.SuspendFunctionGun.

Properties

bucket

val HttpResponse.bucket: BucketKey?

channelResetPoint

val HttpResponse.channelResetPoint: Instant

identifier

val Request<*, *>.identifier: RequestIdentifier

isChannelRateLimit

val HttpResponse.isChannelRateLimit: Boolean

isError

val HttpResponse.isError: Boolean

isErrorWithRateLimit

val HttpResponse.isErrorWithRateLimit: Boolean

isGlobalRateLimit

val HttpResponse.isGlobalRateLimit: Boolean

isRateLimit

val HttpResponse.isRateLimit: Boolean

rateLimitRemaining

val HttpResponse.rateLimitRemaining: Long?

rateLimitTotal

val HttpResponse.rateLimitTotal: Long?

Functions

auditLogReason

fun <T> RequestBuilder<T>.auditLogReason(reason: String?)

Sets the reason that will show up in the Discord Audit Log to reason for this request.

channelResetPoint

fun HttpResponse.channelResetPoint(clock: Clock): Instant

errorString

suspend fun HttpResponse.errorString(): String

file

fun <T> RequestBuilder<T>.file(path: Path)

from

fun RequestResponse.Companion.from(response: HttpResponse, clock: Clock): RequestResponse

globalSuspensionPoint

fun HttpResponse.globalSuspensionPoint(clock: Clock): Long

The unix time (in ms) when the global rate limit gets reset.

KtorRequestHandler

fun KtorRequestHandler(token: String, requestRateLimiter: RequestRateLimiter = ExclusionRequestRateLimiter(), clock: Clock = Clock.System, parser: Json = jsonDefault): KtorRequestHandler

logString

fun Request<*, *>.logString(body: String): String

fun HttpResponse.logString(body: String): String

withStackTraceRecovery

fun KtorRequestHandler.withStackTraceRecovery(): StackTraceRecoveringKtorRequestHandler

Returns a new RequestHandler with stack trace recovery enabled.