BotCommands-core/io.github.freya022.botcommands.api.components.event/ButtonEvent

ButtonEvent

class ButtonEvent : ButtonInteractionEvent, CancellableRateLimit, LocalizableInteraction, LocalizableReplyCallback, LocalizableEditCallback(source)

Interaction event for buttons.

Localization

You can send localized replies and edit messages using the user, guild and also any Locale, by using this event directly, but also the interaction hook, see LocalizableInteraction for more details and configuration.

An alternative to using this event is injecting an AppLocalizationContext in a parameter, or retrieving one using getLocalizationContext.

In both cases, you can configure the user and guild locales, using UserLocaleProvider and GuildLocaleProvider.

Rate limit cancellation

Although it is recommended to reject commands using ComponentInteractionFilter, you can also return the bucket token with cancelRateLimit if you want to avoid consuming bandwidth in certain conditions.

Properties

@get:Nonnull

open val button: Button

@get:Nonnull

open override val channel: MessageChannelUnion

@get:Nullable

open val channelId: String?

open override val channelIdLong: Long

@get:Nonnull

open val channelType: ChannelType

@get:Nonnull

open val component: Button

@get:Nonnull

open override val componentId: String

@get:Nonnull

open override val componentType: Component.Type

val context: BContext

@get:Nonnull

open override val context: InteractionContextType

@get:Nonnull

open val customId: String

@get:Nonnull

open override val entitlements: List<Entitlement?>

@get:Nullable

open override val guild: Guild?

@get:Nonnull

open override val guildChannel: GuildMessageChannelUnion

@get:Nonnull

open override val guildLocale: DiscordLocale

open override val hook: LocalizableInteractionHook

@get:Nonnull

open val id: String

open override val idLong: Long

val Interaction.inputUser: InputUser

Gets the interaction user as an InputUser.

integrationOwners

@get:Nonnull

open override val integrationOwners: IntegrationOwners

@get:Nonnull

open val interaction: ButtonInteraction

open override val isAcknowledged: Boolean

isFromAttachedGuild

open val isFromAttachedGuild: Boolean

open val isFromGuild: Boolean

isRateLimitCancelled

open override val isRateLimitCancelled: Boolean

@get:Nonnull

open override val jda: JDA

localizationBundle

open override var localizationBundle: String?

If set, forces the specified localization bundle to be used.

localizationPrefix

open override var localizationPrefix: String?

If set, adds the specified prefix to the path of every localization call, useful to avoid using very long strings in every reply/edit.

@get:Nullable

open override val member: Member?

@get:Nonnull

open override val message: Message

@get:Nonnull

open val messageChannel: MessageChannel

@get:Nonnull

open val messageId: String

open override val messageIdLong: Long

open override val rawData: DataObject?

open val responseNumber: Long

@get:Nonnull

open val timeCreated: OffsetDateTime

@get:Nonnull

open override val token: String

@get:Nonnull

open val type: InteractionType

open override val typeRaw: Int

open val uniqueId: Int

@get:Nonnull

open override val user: User

@get:Nonnull

open override val userLocale: DiscordLocale

Functions

cancelRateLimit

open override fun cancelRateLimit()

Cancels the token consumption of the current rate limited interaction.

@Nonnull

@CheckReturnValue

open fun deferEdit(): MessageEditCallbackAction

@Nonnull

@CheckReturnValue

open fun deferReply(): ReplyCallbackAction

@Nonnull

@CheckReturnValue

open fun deferReply(ephemeral: Boolean): ReplyCallbackAction

@Nonnull

@CheckReturnValue

open fun editButton(@Nullable newButton: Button?): RestAction<Void?>

@Nonnull

@CheckReturnValue

open fun editComponents(@Nonnull components: Collection<out MessageTopLevelComponent?>): MessageEditCallbackAction

@Nonnull

@CheckReturnValue

open fun editComponents(@Nonnull vararg components: MessageTopLevelComponent?): MessageEditCallbackAction

@Nonnull

@CheckReturnValue

open fun editComponents(@Nonnull tree: ComponentTree<out MessageTopLevelComponent?>): MessageEditCallbackAction

@CheckReturnValue

open override fun editGuild(localizationPath: String, vararg entries: Localization.Entry): MessageEditCallbackAction

Edits the original message with the localized message at the following path, using the guild's locale and provided parameters.

fun LocalizableEditCallback.editGuild(localizationPath: String, vararg entries: PairEntry): MessageEditCallbackAction

Edits the original message with the localized message at the following path, using the guild's locale and provided parameters.

@CheckReturnValue

open override fun editLocalized(locale: Locale, localizationPath: String, vararg entries: Localization.Entry): MessageEditCallbackAction

@CheckReturnValue

open override fun editLocalized(locale: DiscordLocale, localizationPath: String, vararg entries: Localization.Entry): MessageEditCallbackAction

Edits the original message with the localized message at the following path, using the provided locale and parameters.

fun IMessageEditCallback.editLocalized(context: LocalizationContext, localizationPath: String, vararg entries: PairEntry): MessageEditCallbackAction

Edits the text content of the original message with a localized message.

fun LocalizableEditCallback.editLocalized(locale: Locale, localizationPath: String, vararg entries: PairEntry): MessageEditCallbackAction

fun LocalizableEditCallback.editLocalized(locale: DiscordLocale, localizationPath: String, vararg entries: PairEntry): MessageEditCallbackAction

Edits the original message with the localized message at the following path, using the provided locale and parameters.

@Nonnull

@CheckReturnValue

open fun editMessage(@Nonnull content: String): MessageEditCallbackAction

@Nonnull

@CheckReturnValue

open fun editMessage(@Nonnull message: MessageEditData): MessageEditCallbackAction

editMessageAttachments

@Nonnull

@CheckReturnValue

open fun editMessageAttachments(@Nonnull attachments: Collection<out AttachedFile?>): MessageEditCallbackAction

@Nonnull

@CheckReturnValue

open fun editMessageAttachments(@Nonnull vararg attachments: AttachedFile?): MessageEditCallbackAction

editMessageEmbeds

@Nonnull

@CheckReturnValue

open fun editMessageEmbeds(@Nonnull embeds: Collection<out MessageEmbed?>): MessageEditCallbackAction

@Nonnull

@CheckReturnValue

open fun editMessageEmbeds(@Nonnull vararg embeds: MessageEmbed?): MessageEditCallbackAction

editMessageFormat

@Nonnull

@CheckReturnValue

open fun editMessageFormat(@Nonnull format: String, @Nonnull vararg args: Any?): MessageEditCallbackAction

@CheckReturnValue

open override fun editUser(localizationPath: String, vararg entries: Localization.Entry): MessageEditCallbackAction

Edits the original message with the localized message at the following path, using the user's locale and provided parameters.

fun LocalizableEditCallback.editUser(localizationPath: String, vararg entries: PairEntry): MessageEditCallbackAction

Edits the original message with the localized message at the following path, using the user's locale and provided parameters.

getBotCommandsMessages

open override fun getBotCommandsMessages(): BotCommandsMessages

Retrieves a BotCommandsMessages instance, using a locale suitable for messages sent to the user.

@Nonnull

open fun getChannel(): MessageChannelUnion

getChannelIdLong

open fun getChannelIdLong(): Long

@Nonnull

open fun getComponentId(): String

getComponentType

@Nonnull

open fun getComponentType(): Component.Type

@Nonnull

open fun getContext(): InteractionContextType

getDefaultMessages

open override fun ~~getDefaultMessages~~(): DefaultMessages

Retrieves a DefaultMessages instance, using a locale suitable for messages sent to the user.

getEntitlements

@Nonnull

open fun getEntitlements(): List<Entitlement?>

@Nullable

open fun getGuild(): Guild?

getGuildChannel

@Nonnull

open fun getGuildChannel(): GuildMessageChannelUnion

@Nonnull

open fun getGuildLocale(): DiscordLocale

getGuildMessage

open override fun getGuildMessage(localizationPath: String, vararg entries: Localization.Entry): String

Returns the localized message at the following path, using the guild's locale and parameters.

getGuildMessage

fun LocalizableInteraction.getGuildMessage(localizationPath: String, vararg entries: PairEntry): String

Returns the localized message at the following path, using the guild's locale and parameters.

open override fun getHook(): LocalizableInteractionHook

open fun getIdLong(): Long

getIntegrationOwners

@Nonnull

open fun getIntegrationOwners(): IntegrationOwners

@Nonnull

open fun getJDA(): JDA

getLocalizationContext

open override fun getLocalizationContext(bundleName: String, pathPrefix: String?): AppLocalizationContext

Returns a localization context for the provided bundle name and path prefix, using the locales from UserLocaleProvider.getDiscordLocale and GuildLocaleProvider.getDiscordLocale.

getLocalizedMessage

open override fun getLocalizedMessage(locale: Locale, localizationPath: String, vararg entries: Localization.Entry): String

open override fun getLocalizedMessage(locale: DiscordLocale, localizationPath: String, vararg entries: Localization.Entry): String

Returns the localized message at the following path, using the provided locale and parameters.

getLocalizedMessage

fun LocalizableAction.getLocalizedMessage(locale: Locale, localizationPath: String, vararg entries: PairEntry): String

fun LocalizableAction.getLocalizedMessage(locale: DiscordLocale, localizationPath: String, vararg entries: PairEntry): String

@Nullable

open fun getMember(): Member?

@Nonnull

open fun getMessage(): Message

getMessageIdLong

open fun getMessageIdLong(): Long

open override fun getRawData(): DataObject?

@Nonnull

open fun getToken(): String

open fun getTypeRaw(): Int

@Nonnull

open fun getUser(): User

@Nonnull

open fun getUserLocale(): DiscordLocale

open override fun getUserMessage(localizationPath: String, vararg entries: Localization.Entry): String

Returns the localized message at the following path, using the user's locale and parameters.

fun LocalizableInteraction.getUserMessage(localizationPath: String, vararg entries: PairEntry): String

Returns the localized message at the following path, using the user's locale and parameters.

open fun isAcknowledged(): Boolean

replaceLocalized

fun IMessageEditCallback.replaceLocalized(context: LocalizationContext, localizationPath: String, vararg entries: PairEntry): MessageEditCallbackAction

Replaces the entire original message with a localized message.

@Nonnull

@CheckReturnValue

open fun reply(@Nonnull content: String): ReplyCallbackAction

@Nonnull

@CheckReturnValue

open fun reply(@Nonnull message: MessageCreateData): ReplyCallbackAction

replyComponents

@Nonnull

@CheckReturnValue

open fun replyComponents(@Nonnull components: Collection<out MessageTopLevelComponent?>): ReplyCallbackAction

@Nonnull

@CheckReturnValue

open fun replyComponents(@Nonnull tree: ComponentTree<out MessageTopLevelComponent?>): ReplyCallbackAction

@Nonnull

@CheckReturnValue

open fun replyComponents(@Nonnull component: MessageTopLevelComponent, @Nonnull vararg other: MessageTopLevelComponent?): ReplyCallbackAction

@Nonnull

@CheckReturnValue

open fun replyEmbeds(@Nonnull embeds: Collection<out MessageEmbed?>): ReplyCallbackAction

@Nonnull

@CheckReturnValue

open fun replyEmbeds(@Nonnull embed: MessageEmbed, @Nonnull vararg embeds: MessageEmbed?): ReplyCallbackAction

@Nonnull

@CheckReturnValue

open fun replyFiles(@Nonnull files: Collection<out FileUpload?>): ReplyCallbackAction

@Nonnull

@CheckReturnValue

open fun replyFiles(@Nonnull vararg files: FileUpload?): ReplyCallbackAction

@Nonnull

@CheckReturnValue

open fun replyFormat(@Nonnull format: String, @Nonnull vararg args: Any?): ReplyCallbackAction

@CheckReturnValue

open override fun replyGuild(localizationPath: String, vararg entries: Localization.Entry): ReplyCallbackAction

Replies with the localized message at the following path, using the guild's locale and provided parameters.

fun LocalizableReplyCallback.replyGuild(localizationPath: String, vararg entries: PairEntry): ReplyCallbackAction

Replies with the localized message at the following path, using the guild's locale and provided parameters.

@CheckReturnValue

open override fun replyLocalized(locale: Locale, localizationPath: String, vararg entries: Localization.Entry): ReplyCallbackAction

@CheckReturnValue

open override fun replyLocalized(locale: DiscordLocale, localizationPath: String, vararg entries: Localization.Entry): ReplyCallbackAction

Replies with the localized message at the following path, using the provided locale and parameters.

fun IReplyCallback.replyLocalized(context: LocalizationContext, localizationPath: String, vararg entries: PairEntry): ReplyCallbackAction

Replies a localized message to this interaction and acknowledges it.

fun LocalizableReplyCallback.replyLocalized(locale: Locale, localizationPath: String, vararg entries: PairEntry): ReplyCallbackAction

fun LocalizableReplyCallback.replyLocalized(locale: DiscordLocale, localizationPath: String, vararg entries: PairEntry): ReplyCallbackAction

Replies with the localized message at the following path, using the provided locale and parameters.

replyLocalizedEphemeral

fun IReplyCallback.replyLocalizedEphemeral(context: LocalizationContext, localizationPath: String, vararg entries: PairEntry): ReplyCallbackAction

Replies a localized ephemeral message to this interaction and acknowledges it.

@Nonnull

@CheckReturnValue

open fun replyModal(@Nonnull modal: Modal): ModalCallbackAction

@Nonnull

@CheckReturnValue

open fun replyPoll(@Nonnull poll: MessagePollData): ReplyCallbackAction

@CheckReturnValue

open override fun replyUser(localizationPath: String, vararg entries: Localization.Entry): ReplyCallbackAction

Replies with the localized message at the following path, using the user's locale and provided parameters.

fun LocalizableReplyCallback.replyUser(localizationPath: String, vararg entries: PairEntry): ReplyCallbackAction

Replies with the localized message at the following path, using the user's locale and provided parameters.