BotCommands-jda-ktx/dev.freya02.botcommands.jda.ktx.components

Package-level declarations

Types

InlineActionRow

class InlineActionRow : InlineComponent

InlineAttachmentUpload

class InlineAttachmentUpload(val builder: AttachmentUpload.Builder) : InlineComponent

InlineCheckbox

class InlineCheckbox : InlineComponent

InlineCheckboxGroup

class InlineCheckboxGroup(val builder: CheckboxGroup.Builder) : InlineComponent

InlineComponent

interface InlineComponent

InlineContainer

class InlineContainer : InlineComponent

InlineEntitySelectMenu

class InlineEntitySelectMenu(val builder: EntitySelectMenu.Builder, types: Collection<EntitySelectMenu.SelectTarget>) : InlineSelectMenu

InlineFileDisplay

class InlineFileDisplay(fileDisplay: FileDisplay) : InlineComponent

InlineLabel

class InlineLabel : InlineComponent

InlineMediaGallery

class InlineMediaGallery : InlineComponent

InlineMediaGalleryItem

class InlineMediaGalleryItem(item: MediaGalleryItem)

InlineRadioGroup

class InlineRadioGroup(val builder: RadioGroup.Builder) : InlineComponent

InlineSection

class InlineSection : InlineComponent

InlineSelectMenu

abstract class InlineSelectMenu : InlineComponent

InlineSeparator

class InlineSeparator : InlineComponent

InlineStringSelectMenu

class InlineStringSelectMenu(val builder: StringSelectMenu.Builder) : InlineSelectMenu

InlineTextDisplay

class InlineTextDisplay : InlineComponent

InlineTextInput

class InlineTextInput(val builder: TextInput.Builder) : InlineComponent

InlineThumbnail

class InlineThumbnail(thumbnail: Thumbnail) : InlineComponent

Functions

ActionRow

inline fun ActionRow(uniqueId: Int = -1, block: InlineActionRow.() -> Unit): ActionRow

See ActionRow.

asDisabled

fun <T : Component> Iterable<T>.asDisabled(): List<T>

Returns a list containing the results of disabling each component in the original collection.

fun <T : Component> Sequence<T>.asDisabled(): Sequence<T>

Returns a sequence containing the results of disabling each component in the original sequence.

asEnabled

fun <T : Component> Iterable<T>.asEnabled(): List<T>

Returns a list containing the results of enabling each component in the original collection.

fun <T : Component> Sequence<T>.asEnabled(): Sequence<T>

Returns a sequence containing the results of enabling each component in the original sequence.

AttachmentUpload

inline fun AttachmentUpload(customId: String, uniqueId: Int = -1, required: Boolean = true, range: IntRange? = null, block: InlineAttachmentUpload.() -> Unit = {}): AttachmentUpload

Component accepting files from users, see AttachmentUpload.

Checkbox

inline fun Checkbox(customId: String, uniqueId: Int = -1, isDefault: Boolean = false, block: InlineCheckbox.() -> Unit = {}): Checkbox

A component displaying a box which can be checked. Useful for simple yes/no questions.

CheckboxGroup

inline fun CheckboxGroup(customId: String, uniqueId: Int = -1, valueRange: IntRange? = null, required: Boolean = true, block: InlineCheckboxGroup.() -> Unit): CheckboxGroup

A component displaying a group of up to OPTIONS_MAX_AMOUNT checkboxes which can be checked independently.

CheckboxGroupOption

fun CheckboxGroupOption(label: String, value: String, description: String? = null, default: Boolean = false): CheckboxGroupOption

Creates a CheckboxGroupOption.

Container

inline fun Container(uniqueId: Int = -1, accentColor: Int? = null, spoiler: Boolean = false, block: InlineContainer.() -> Unit): Container

See Container.

EntitySelectMenu

inline fun EntitySelectMenu(customId: String, types: Collection<EntitySelectMenu.SelectTarget>, uniqueId: Int = -1, placeholder: String? = null, valueRange: IntRange? = null, channelTypes: Collection<ChannelType> = emptyList(), defaultValues: Collection<EntitySelectMenu.DefaultValue> = emptyList(), required: Boolean? = null, disabled: Boolean = false, block: InlineEntitySelectMenu.() -> Unit = {}): EntitySelectMenu

inline fun EntitySelectMenu(customId: String, type: EntitySelectMenu.SelectTarget, vararg types: EntitySelectMenu.SelectTarget, uniqueId: Int = -1, placeholder: String? = null, valueRange: IntRange? = null, channelTypes: Collection<ChannelType> = emptyList(), defaultValues: Collection<EntitySelectMenu.DefaultValue> = emptyList(), required: Boolean? = null, disabled: Boolean = false, block: InlineEntitySelectMenu.() -> Unit = {}): EntitySelectMenu

Represents a selection of options, see EntitySelectMenu.

FileDisplay

fun FileDisplay(fileName: String, uniqueId: Int = -1, spoiler: Boolean = false, block: InlineFileDisplay.() -> Unit = {}): FileDisplay

See FileDisplay.fromFileName.

fun FileDisplay(file: FileUpload, uniqueId: Int = -1, spoiler: Boolean = false, block: InlineFileDisplay.() -> Unit = {}): FileDisplay

See FileDisplay.fromFile.

find

inline fun <T : Component> ComponentTree<*>.find(crossinline filter: (T) -> Boolean): T?

Finds the first component of type T satisfying the filter, recursively.

findAll

inline fun <T : Component> ComponentTree<*>.findAll(): List<T>

Finds all components of type T, recursively.

inline fun <T : Component> ComponentTree<T>.findAll(crossinline filter: (T) -> Boolean): List<T>

Finds all components of type T satisfying the filter, recursively.

into

fun <T : ActionRow> T.into(): List<T>

@JvmName(name = "intoComponents")

fun <T : ActionRowChildComponent> Collection<T>.into(): List<ActionRow>

fun ActionRowChildComponent.into(): List<ActionRow>

Label

inline fun Label(label: String? = null, uniqueId: Int = -1, description: String? = null, child: LabelChildComponent? = null, block: InlineLabel.() -> Unit = {}): Label

Component that contains a label, an optional description, and a child component, see Label.

link

fun link(url: String, label: String? = null, emoji: Emoji? = null, disabled: Boolean = false): Button

MediaGallery

inline fun MediaGallery(uniqueId: Int = -1, block: InlineMediaGallery.() -> Unit): MediaGallery

See MediaGallery.

MediaGalleryItem

inline fun MediaGalleryItem(url: String, description: String? = null, spoiler: Boolean = false, block: InlineMediaGalleryItem.() -> Unit = {}): MediaGalleryItem

See MediaGalleryItem.fromUrl.

inline fun MediaGalleryItem(file: FileUpload, description: String? = null, spoiler: Boolean = false, block: InlineMediaGalleryItem.() -> Unit = {}): MediaGalleryItem

See MediaGalleryItem.fromFile.

option

fun CheckboxGroup.Builder.option(label: String, value: String, description: String? = null, default: Boolean = false): CheckboxGroup.Builder

Adds an option to this select menu, see CheckboxGroupOption.

fun RadioGroup.Builder.option(label: String, value: String, description: String? = null, default: Boolean = false): RadioGroup.Builder

Adds an option to this select menu, see RadioGroupOption.

fun StringSelectMenu.Builder.option(label: String, value: String, description: String? = null, emoji: Emoji? = null, default: Boolean = false): StringSelectMenu.Builder

Adds an option to this select menu, see SelectOption.

RadioGroup

inline fun RadioGroup(customId: String, uniqueId: Int = -1, required: Boolean = true, block: InlineRadioGroup.() -> Unit): RadioGroup

A component displaying a group of up to OPTIONS_MAX_AMOUNT radio buttons, in which only one can be chosen.

RadioGroupOption

fun RadioGroupOption(label: String, value: String, description: String? = null, default: Boolean = false): RadioGroupOption

Creates a RadioGroupOption.

row

fun row(component: ActionRowChildComponent, vararg components: ActionRowChildComponent): ActionRow

Construct an ActionRow from the provided components

row

fun Collection<ActionRowChildComponent>.row(): ActionRow

Construct an ActionRow from the provided components

Section

inline fun Section(accessory: SectionAccessoryComponent? = null, uniqueId: Int = -1, block: InlineSection.() -> Unit): Section

See Section.

SelectOption

fun SelectOption(label: String, value: String, description: String? = null, emoji: Emoji? = null, default: Boolean = false): SelectOption

Creates a select menu option, see SelectOption.

Separator

inline fun Separator(uniqueId: Int = -1, isDivider: Boolean = true, spacing: Separator.Spacing = Spacing.SMALL, block: InlineSeparator.() -> Unit = {}): Separator

See Separator.

setRequiredRange

fun AttachmentUpload.Builder.setRequiredRange(range: IntRange): AttachmentUpload.Builder

Sets the minimum and maximum amount of files a user can send, see AttachmentUpload.Builder.setRequiredRange.

fun TextInput.Builder.setRequiredRange(range: IntRange): TextInput.Builder

Sets the minimum and maximum required length on this TextInput component.

StringSelectMenu

inline fun StringSelectMenu(customId: String, uniqueId: Int = -1, placeholder: String? = null, valueRange: IntRange? = null, required: Boolean? = null, disabled: Boolean = false, block: InlineStringSelectMenu.() -> Unit): StringSelectMenu

Represents a selection of options, see StringSelectMenu.

TextDisplay

inline fun TextDisplay(content: String? = null, uniqueId: Int = -1, block: InlineTextDisplay.() -> Unit = {}): TextDisplay

See TextDisplay.

TextInput

inline fun TextInput(customId: String, style: TextInputStyle, uniqueId: Int = -1, isRequired: Boolean = true, range: IntRange? = null, value: String? = null, placeholder: String? = null, block: InlineTextInput.() -> Unit = {}): TextInput

Discord text input, see TextInput.

Thumbnail

fun Thumbnail(url: String, uniqueId: Int = -1, description: String? = null, spoiler: Boolean = false, block: InlineThumbnail.() -> Unit = {}): Thumbnail

See Thumbnail.fromUrl.

fun Thumbnail(file: FileUpload, uniqueId: Int = -1, description: String? = null, spoiler: Boolean = false, block: InlineThumbnail.() -> Unit = {}): Thumbnail

See Thumbnail.fromFile.

toComponentTree

inline fun <T : IComponentUnion> Collection<Component>.toComponentTree(): ComponentTree<T>

toDefaultComponentTree

fun Collection<Component>.toDefaultComponentTree(): ComponentTree<IComponentUnion>

Creates a ComponentTree of IComponentUnion from this collection.

withDisabled

fun <T : Component> Iterable<T>.withDisabled(disabled: Boolean): List<T>

Returns a list containing the results of disabling/enabling each component in the original collection.

fun <T : Component> Sequence<T>.withDisabled(disabled: Boolean): Sequence<T>

Returns a sequence containing the results of disabling/enabling each component in the original sequence.