BotCommands/io.github.freya022.botcommands.api.components

Package-level declarations

Types

AbstractComponentFactory

abstract class AbstractComponentFactory

AwaitableComponent

interface AwaitableComponent<T : ComponentInteraction> : IdentifiableComponent

Button

interface Button : Button, AwaitableComponent<ButtonEvent> , IGroupHolder

Buttons

@BService

class Buttons : AbstractComponentFactory

Factory for buttons, see Components for more details.

ComponentGroup

class ComponentGroup : IdentifiableComponent, AwaitableComponent<GenericComponentInteractionCreateEvent>

ComponentInteractionFilter

@InterfacedService(acceptMultiple = true)

interface ComponentInteractionFilter<T : Any> : Filter

Prevents component execution by returning an error object to the component executor.

ComponentInteractionRejectionHandler

@InterfacedService(acceptMultiple = false)

interface ComponentInteractionRejectionHandler<T : Any>

Processes component interaction rejections returned by component interaction filters.

Components

@BService

class Components : AbstractComponentFactory

This class lets you create smart components such as buttons, select menus, and groups.

EntitySelectMenu

interface EntitySelectMenu : EntitySelectMenu, AwaitableComponent<EntitySelectEvent> , IGroupHolder

IdentifiableComponent

interface IdentifiableComponent

IGroupHolder

interface IGroupHolder : IdentifiableComponent

SelectMenus

@BService

class SelectMenus : AbstractComponentFactory

Factory for select menus, see Components for more details.

StringSelectMenu

interface StringSelectMenu : StringSelectMenu, AwaitableComponent<StringSelectEvent> , IGroupHolder

Functions

and

infix fun <T : Any> ComponentInteractionFilter<T>.and(other: ComponentInteractionFilter<T>): ComponentInteractionFilter<T>

awaitAny

suspend fun <T : GenericComponentInteractionCreateEvent> ComponentGroup.awaitAny(): T

Suspends until the component is used and all checks passed, and returns the event.

awaitAnyOrNull

suspend fun <T : GenericComponentInteractionCreateEvent> ComponentGroup.awaitAnyOrNull(): T?

Suspends until the component is used and all checks passed, and returns the event, or null if the timeout has been reached.

awaitOrNull

suspend fun <T : ComponentInteraction> AwaitableComponent<T>.awaitOrNull(): T?

Suspends until the component is used and all checks passed, and returns the event, or null if the timeout has been reached.

infix fun <T : Any> ComponentInteractionFilter<T>.or(other: ComponentInteractionFilter<T>): ComponentInteractionFilter<T>