kiscord-core/kiscord.ktor

Package-level declarations

Plugins for Ktor client for use within Kiscord

Types

HttpClientFactory

sealed class HttpClientFactory

KiscordAuthentication

class KiscordAuthentication

Kiscord feature to Ktor to allow authentication for requests.

KiscordBranding

class KiscordBranding

Kiscord module for Ktor that provides User-Agent according to the reference.

KiscordRequestMixin

fun interface KiscordRequestMixin : CoroutineContext.Element

SerializableMultiPart

data class SerializableMultiPart(val parts: List<SerializablePart>)

SerializableMultiPartCoder

class SerializableMultiPartCoder

SerializableMultiPartDsl

@Target(allowedTargets = [AnnotationTarget.ANNOTATION_CLASS, AnnotationTarget.FUNCTION, AnnotationTarget.CLASS, AnnotationTarget.PROPERTY])

annotation class SerializableMultiPartDsl

Kiscord's DSL to perform reflection-less requests using ktor and kotlinx.serialization

SerializablePart

class SerializablePart : BuilderFor<SerializablePart>

Functions

anonymous

fun HttpRequestBuilder.anonymous(value: Boolean = true)

contentType

fun SerializableMultiPartCoder.Codec.Builder<*>.contentType(contentType: ContentType)

deferredValue

fun <T : Any> SerializablePart.deferredValue(value: suspend () -> Pair<T, SerializationStrategy<T>>)

deferredValueOfByteArray

fun SerializablePart.deferredValueOfByteArray(value: suspend () -> ByteArray)

deferredValueOfString

fun SerializablePart.deferredValueOfString(value: suspend () -> String)

dispose

fun SerializablePart.dispose(block: () -> Unit)

json

fun SerializableMultiPartCoder.TextCodec.Builder.json(json: Json)

mixin

inline fun Kiscord.mixin(crossinline mixin: HttpRequestBuilder.() -> Unit): KiscordRequestMixin

multipartBody

inline fun HttpRequestBuilder.multipartBody(block: SerializableMultiPart.Builder.() -> Unit)

partBody

fun <T : Any> SerializablePart.partBody(value: T, serializer: SerializationStrategy<T>)

textCodec

inline fun SerializableMultiPartCoder.Config.textCodec(block: SerializableMultiPartCoder.TextCodec.Builder.() -> Unit)

token

fun HttpRequestBuilder.token(token: Token)

valueOfByteArray

fun SerializablePart.valueOfByteArray(value: ByteArray)

valueOfInput

fun SerializablePart.valueOfInput(value: () -> Input)

valueOfString

fun SerializablePart.valueOfString(value: String)

withMixin

inline suspend fun <T> Kiscord.withMixin(crossinline mixin: HttpRequestBuilder.() -> Unit, noinline block: suspend Kiscord.() -> T): T