kiscord-core/kiscord.api

Package-level declarations

Contains all models and helper functions for Discord REST API

Types

ApplicationCommandOptionChoice

@Serializable(with = ApplicationCommandOptionChoice.Serializer::class)

class ApplicationCommandOptionChoice

ApplicationCommandOptionCoerceValue

@Serializable(with = ApplicationCommandOptionCoerceValue.Serializer::class)

sealed class ApplicationCommandOptionCoerceValue

AuditLogChange

@Serializable

data class AuditLogChange<out T : Any>(val key: AuditLogChangeKey, val newValue: T? = null, val oldValue: T? = null)

Discord API Reference

AuditLogEntry

@Serializable

data class AuditLogEntry(val targetId: String? = null, val changes: List<AuditLogChange<Any>>? = null, val userId: Snowflake? = null, val id: Snowflake, val actionType: AuditLogEvent, val reason: String? = null)

Discord API Reference

Box

@JvmInline

@Serializable(with = Box.Serializer::class)

value class Box<out T>

Box is generic container for type T, which can be marked as absent (empty). Behaves similarly to Java's Optional, but allows nullable types as well.

DataUri

@Serializable(with = DataUri.Serializer::class)

sealed class DataUri

DiscordApiDsl

@DslMarker

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

annotation class DiscordApiDsl

EmbedValidationException

class EmbedValidationException : RuntimeException

FileData

data class FileData(val data: () -> Input, val filename: String, val contentType: ContentType = ContentType.Application.OctetStream)

FormatTag

sealed class FormatTag

Generated

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

annotation class Generated

Marks symbol being automatically generated by codegen

Image

sealed class Image

Discord API Reference

InteractionDataOption

@Serializable(with = InteractionDataOption.Serializer::class)

class InteractionDataOption

KiscordUnstableAPI

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

annotation class KiscordUnstableAPI

MessageFilter

fun interface MessageFilter

General-purpose interface for filtering messages.

MessageList

interface MessageList

List-like interface to transparently access cached and retrieve not-yet-received messages from Discord.

OSName

enum OSName : Enum<OSName>

Enumeration of OS supported by Kiscord

PermissionSet

@Serializable(with = PermissionSet.Serializer::class)

class PermissionSet constructor(flags: ULong) : AbstractSet<Permission>

Efficiently stores a permission set

ResponseResult

interface ResponseResult

RestChannelMessageList

class RestChannelMessageList(val client: Kiscord, val channelId: Snowflake, filter: MessageFilter = MessageFilter.All) : MessageList

Snowflake

@Serializable(with = Snowflake.Serializer::class)

class Snowflake(val id: ULong) : Comparable<Snowflake>

Discord utilizes Twitter's snowflake format for uniquely identifiable descriptors (IDs). These IDs are guaranteed to be unique across all of Discord, except in some unique scenarios in which child objects share their parent's ID.

SnowflakeRange

class SnowflakeRange(val start: Snowflake, val endInclusive: Snowflake) : ClosedRange<Snowflake>

Token

sealed class Token

UnavailableGuild

@Serializable

data class UnavailableGuild(val id: Snowflake, val unavailable: Boolean) : GuildSpec

UnknownResponseException

class UnknownResponseException(val code: HttpStatusCode) : RuntimeException

Functions

actionRow

inline fun Component.ActionRow.Builder.actionRow(block: Component.ActionRow.Builder.() -> Unit)

inline fun MutableCollection<in Component>.actionRow(block: Component.ActionRow.Builder.() -> Unit)

and

inline fun MessageFilter.Builder.and(block: MessageFilter.Builder.() -> Unit)

asReference

fun Message.asReference(failIfNotExists: Boolean = true): MessageReference

Create reference from the given message.

asset

fun Application.asset(id: Snowflake): Image.ApplicationAsset

fun Application.asset(id: String): Image.ApplicationAsset

attachment

fun Embed.Image.Builder.attachment(attachment: Attachment)

autocomplete

@DiscordApiDsl

inline suspend fun Interaction.autocomplete(result: Interaction.Response.Data.Autocomplete): Boolean

@DiscordApiDsl

inline suspend fun Interaction.autocomplete(crossinline block: Interaction.Response.Data.Autocomplete.Builder.() -> Unit = {}): Boolean

Must be called in KiscordCall context

button

inline fun Component.ActionRow.Builder.button(block: Component.Button.Builder.() -> Unit)

inline fun MutableCollection<in Component>.button(block: Component.Button.Builder.() -> Unit)

fun Activity.Builder.button(label: String, url: Url)

fun Activity.Builder.button(label: String, url: String)

choice

fun ApplicationCommandOption.Builder.choice(name: String, value: Double)

fun ApplicationCommandOption.Builder.choice(name: String, value: Long)

fun ApplicationCommandOption.Builder.choice(name: String, value: String)

fun Interaction.Response.Data.Autocomplete.Builder.choice(name: String, value: Double)

fun Interaction.Response.Data.Autocomplete.Builder.choice(name: String, value: Long)

fun Interaction.Response.Data.Autocomplete.Builder.choice(name: String, value: String)

coerceValue

@JvmName(name = "coerceDoubleValue")

fun ApplicationCommandOption.Builder.coerceValue(range: ClosedRange<Double>)

@JvmName(name = "coerceLongValue")

fun ApplicationCommandOption.Builder.coerceValue(range: ClosedRange<Long>)

fun ApplicationCommandOption.Builder.coerceValue(minValue: Double, maxValue: Double)

fun ApplicationCommandOption.Builder.coerceValue(minValue: Long, maxValue: Long)

competing

fun Activity.Builder.competing(name: String)

component1

operator fun Snowflake.component1(): ULong

component2

operator fun Snowflake.component2(): Byte

component3

operator fun Snowflake.component3(): Byte

component4

operator fun Snowflake.component4(): Short

computeIfNull

infix inline fun <T : Any> Box<T?>.computeIfNull(another: () -> T): T

contains

operator fun ActivitySpec.contains(flag: Activity.Flag): Boolean

createMessageWithTypingIndicator

@DiscordApiDsl

suspend fun ChannelApi.createMessageWithTypingIndicator(channelId: Snowflake, block: suspend CreateMessage.Builder.() -> Unit): Message

createReaction

@DiscordApiDsl

inline suspend fun ChannelApi.createReaction(channelId: Snowflake, messageId: Snowflake, emoji: String): Boolean

Create a reaction for the message. This endpoint requires the 'READ_MESSAGE_HISTORY' permission to be present on the current user. Additionally, if nobody else has reacted to the message using this emoji, this endpoint requires the 'ADD_REACTIONS' permission to be present on the current user. Returns a 204 empty response on success.

deleteAllReactionsForEmoji

@DiscordApiDsl