BotCommands-core/io.github.freya022.botcommands.api.components/AbstractComponentFactory

AbstractComponentFactory

abstract class AbstractComponentFactory(source)

Inheritors

Buttons

Components

SelectMenus

Properties

context

val context: BContext

Functions

createRateLimitReference

fun createRateLimitReference(group: String, discriminator: String): ComponentRateLimitReference

Creates a reference to a rate limiter previously declared by a RateLimitProvider, alongside a discriminator which differentiates this component from others under the same group.

deleteComponents

suspend fun deleteComponents(vararg components: IdentifiableComponent)

suspend fun deleteComponents(components: Collection<IdentifiableComponent>)

Removes the component data stored by the framework of the provided components.

deleteComponentsByIds

suspend fun deleteComponentsByIds(vararg ids: Int)

suspend fun deleteComponentsByIds(ids: Collection<Int>)

Removes the component data stored by the framework of the provided components.

deleteComponentsByIdsJava

@JvmName(name = "deleteComponentsByIds")

fun deleteComponentsByIdsJava(vararg ids: Int)

@JvmName(name = "deleteComponentsByIds")

fun deleteComponentsByIdsJava(ids: Collection<Int>)

Removes the component data stored by the framework of the provided components.

deleteComponentsJava

@JvmName(name = "deleteComponents")

fun deleteComponentsJava(vararg components: IdentifiableComponent)

@JvmName(name = "deleteComponents")

fun deleteComponentsJava(components: Collection<IdentifiableComponent>)

Removes the component data stored by the framework of the provided components.

deleteJdaComponents

suspend fun deleteJdaComponents(components: Collection<ICustomId>)

suspend fun deleteJdaComponents(vararg components: ICustomId)

Removes the component data stored by the framework of the provided components.

deleteJdaComponentsJava

@JvmName(name = "deleteJdaComponents")

fun deleteJdaComponentsJava(components: Collection<ICustomId>)

@JvmName(name = "deleteJdaComponents")

fun deleteJdaComponentsJava(vararg components: ICustomId)

Removes the component data stored by the framework of the provided components.

deleteRows

suspend fun deleteRows(components: Collection<MessageTopLevelComponent>)

Removes the component data stored by the framework of the provided components.

deleteRowsJava

@JvmName(name = "deleteRows")

fun deleteRowsJava(components: Collection<MessageTopLevelComponent>)

Removes the component data stored by the framework of the provided components.

deleteTree

suspend fun deleteTree(tree: ComponentTree<*>)

deleteTreeJava

@JvmName(name = "deleteRows")

suspend fun deleteTreeJava(tree: ComponentTree<*>)

getRateLimitReference

fun getRateLimitReference(group: String, discriminator: String): ComponentRateLimitReference?

Gets an existing reference to a ComponentRateLimitReference.

group

@CheckReturnValue

fun group(vararg components: IGroupHolder): ComponentGroupFactory

Creates a group of components.