kord-rest/dev.kord.rest.builder.component

Package-level declarations

Types

AccessoryComponentBuilder

sealed interface AccessoryComponentBuilder : ComponentBuilder

A component that is an accessory to a section component.

AccessoryHolder

interface AccessoryHolder

An object which can have an accessory.

ActionRowBuilder

class ActionRowBuilder : ContainerComponentBuilder

ActionRowComponentBuilder

sealed class ActionRowComponentBuilder : ContainerComponentBuilder

ButtonBuilder

sealed class ButtonBuilder : AccessoryComponentBuilder, ActionRowComponentBuilder

ChannelSelectBuilder

class ChannelSelectBuilder(customId: String) : SelectMenuBuilder

CheckboxBuilder

class CheckboxBuilder(val customId: String) : ContainerComponentBuilder

CheckboxGroupBuilder

class CheckboxGroupBuilder(val customId: String) : ContainerComponentBuilder

ComponentBuilder

sealed interface ComponentBuilder

ComponentContainerBuilder

interface ComponentContainerBuilder

A builder for an object which can contain multiple components.

ContainerBuilder

class ContainerBuilder : ComponentContainerBuilder, MessageComponentBuilder

ContainerComponentBuilder

sealed interface ContainerComponentBuilder : MessageComponentBuilder

A component that is a child of a container component.

FileBuilder

class FileBuilder : ContainerComponentBuilder

FileUploadBuilder

class FileUploadBuilder(val customId: String) : ContainerComponentBuilder

LabelComponentBuilder

class LabelComponentBuilder(val label: String) : ContainerComponentBuilder

MediaGalleryBuilder

class MediaGalleryBuilder : ContainerComponentBuilder

MediaGalleryItemBuilder

class MediaGalleryItemBuilder(var url: String)

MentionableSelectBuilder

class MentionableSelectBuilder(customId: String) : SelectMenuBuilder

MessageComponentBuilder

sealed interface MessageComponentBuilder : ComponentBuilder

PremiumButtonBuilder

class PremiumButtonBuilder(var skuId: Snowflake) : ActionRowComponentBuilder

A button that prompts the user to purchase an SKU.

RadioGroupBuilder

class RadioGroupBuilder(val customId: String) : ContainerComponentBuilder

RoleSelectBuilder

class RoleSelectBuilder(customId: String) : SelectMenuBuilder

SectionBuilder

class SectionBuilder : ContainerComponentBuilder, AccessoryHolder

SelectMenuBuilder

sealed class SelectMenuBuilder : ActionRowComponentBuilder

A builder for a Discord Select Menu.

SelectOptionBuilder

class SelectOptionBuilder(var label: String, var value: String)

A builder for a Discord Select Option.

SeparatorBuilder

class SeparatorBuilder : ContainerComponentBuilder

StringSelectBuilder

class StringSelectBuilder(customId: String) : SelectMenuBuilder

TextDisplayBuilder

class TextDisplayBuilder : ContainerComponentBuilder

TextInputBuilder

class TextInputBuilder(var style: TextInputStyle, var customId: String, var label: String? = null) : ActionRowComponentBuilder

A builder for a Discord Text Input.

ThumbnailBuilder

class ThumbnailBuilder : AccessoryComponentBuilder

UserSelectBuilder

class UserSelectBuilder(customId: String) : SelectMenuBuilder

Functions

actionRow

inline fun ComponentContainerBuilder.actionRow(builder: ActionRowBuilder.() -> Unit)

channelType

fun ChannelSelectBuilder.channelType(type: ChannelType)

file

inline fun ComponentContainerBuilder.file(builder: FileBuilder.() -> Unit)

fileUpload

inline fun ComponentContainerBuilder.fileUpload(customId: String, builder: FileUploadBuilder.() -> Unit)

interactionButtonAccessory

inline fun AccessoryHolder.interactionButtonAccessory(style: ButtonStyle, customId: String, builder: ButtonBuilder.() -> Unit = {})

Adds an interaction button as an accessory to this section. This is mutually exclusive with other accessory components.

label

inline fun ComponentContainerBuilder.label(label: String, builder: LabelComponentBuilder.() -> Unit)

linkButtonAccessory

inline fun AccessoryHolder.linkButtonAccessory(url: String, builder: ButtonBuilder.() -> Unit = {})

Adds a link button as an accessory to this section. This is mutually exclusive with other accessory components.

mediaGallery

inline fun ComponentContainerBuilder.mediaGallery(builder: MediaGalleryBuilder.() -> Unit)

option

inline fun StringSelectBuilder.option(label: String, value: String, builder: SelectOptionBuilder.() -> Unit = {})

Adds a new option to the select menu with the given label and value that can be configured by the builder.

section

inline fun ComponentContainerBuilder.section(builder: SectionBuilder.() -> Unit)

separator

inline fun ComponentContainerBuilder.separator(builder: SeparatorBuilder.() -> Unit)

textDisplay

inline fun ComponentContainerBuilder.textDisplay(builder: TextDisplayBuilder.() -> Unit)