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

StringSelectEvent

class StringSelectEvent : StringSelectInteractionEvent, CancellableRateLimit, LocalizableInteraction, LocalizableReplyCallback, LocalizableEditCallback(source)

Interaction event for string select menus.

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

context

val context: BContext

inputUser

val Interaction.inputUser: InputUser

Gets the interaction user as an InputUser.

isRateLimitCancelled

open override val isRateLimitCancelled: Boolean

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.

Functions

cancelRateLimit

open override fun cancelRateLimit()

Cancels the token consumption of the current rate limited interaction.

deferEdit

@Nonnull

open override fun deferEdit(): MessageEditCallbackAction

deferReply

@Nonnull

open override fun deferReply(): ReplyCallbackAction

@Nonnull

@CheckReturnValue

open fun deferReply(p0: Boolean): ReplyCallbackAction

editComponents

@Nonnull

@CheckReturnValue

open fun editComponents(@Nonnull vararg p0: LayoutComponent): MessageEditCallbackAction

@Nonnull

@CheckReturnValue

open fun editComponents(@Nonnull p0: MutableCollection<out LayoutComponent>): MessageEditCallbackAction

editGuild

@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.

editGuild

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

editLocalized

@CheckReturnValue

open override fun editLocalized(locale: Locale, 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.

@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.

editLocalized

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

editMessage

@Nonnull

@CheckReturnValue

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

@Nonnull

@CheckReturnValue

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

editMessageAttachments

@Nonnull

@CheckReturnValue

open fun editMessageAttachments(@Nonnull vararg p0: AttachedFile): MessageEditCallbackAction

@Nonnull

@CheckReturnValue

open fun editMessageAttachments(@Nonnull p0: MutableCollection<out AttachedFile>): MessageEditCallbackAction

editMessageEmbeds

@Nonnull

@CheckReturnValue

open fun editMessageEmbeds(@Nonnull vararg p0: MessageEmbed): MessageEditCallbackAction

@Nonnull

@CheckReturnValue

open fun editMessageEmbeds(@Nonnull p0: MutableCollection<out MessageEmbed>): MessageEditCallbackAction

editMessageFormat

@Nonnull

@CheckReturnValue

open fun editMessageFormat(@Nonnull p0: String, @Nonnull vararg p1: Any): MessageEditCallbackAction

editSelectMenu

@Nonnull

@CheckReturnValue

open fun editSelectMenu(@Nullable p0: SelectMenu?): RestAction<Void>

editUser

@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.

editUser

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

getChannel

@Nonnull

open override fun getChannel(): MessageChannelUnion

getChannelId

@Nullable

open fun getChannelId(): String?

getChannelIdLong

open override fun getChannelIdLong(): Long

getChannelType

@Nonnull

open fun getChannelType(): ChannelType

getComponent

@Nonnull

open override fun getComponent(): StringSelectMenu

getComponentId

@Nonnull

open override fun getComponentId(): String

getComponentType

@Nonnull

open override fun getComponentType(): Component.Type

getDefaultMessages

open override fun getDefaultMessages(): DefaultMessages

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

getEntitlements

@Nonnull

open override fun getEntitlements(): MutableList<Entitlement>

getGuild

@Nullable

open override fun getGuild(): Guild?

getGuildChannel

@Nonnull

open fun getGuildChannel(): GuildChannel

getGuildLocale

@Nonnull

open override 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

getHook

open override fun getHook(): LocalizableInteractionHook

getId

@Nonnull

open fun getId(): String

getIdLong

open override fun getIdLong(): Long

getInteraction

@Nonnull

open override fun getInteraction(): StringSelectInteraction

getJDA

@Nonnull

open override 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

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

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

getMember

@Nullable

open override fun getMember(): Member?

getMessage

@Nonnull

open override fun getMessage(): Message

getMessageChannel

@Nonnull

open fun getMessageChannel(): MessageChannel

getMessageId

@Nonnull

open fun getMessageId(): String

getMessageIdLong

open override fun getMessageIdLong(): Long

getRawData

open override fun getRawData(): DataObject?

getResponseNumber

open override fun getResponseNumber(): Long

getSelectedOptions

@Nonnull

open fun getSelectedOptions(): @Unmodifiable MutableList<SelectOption>

getSelectMenu

@Nonnull

open fun getSelectMenu(): StringSelectMenu

getTimeCreated

@Nonnull

open fun getTimeCreated(): OffsetDateTime

getToken

@Nonnull

open override fun getToken(): String

getType

@Nonnull

open fun getType(): InteractionType

getTypeRaw

open override fun getTypeRaw(): Int

getUser

@Nonnull

open override fun getUser(): User

getUserLocale

@Nonnull

open override fun getUserLocale(): DiscordLocale

getUserMessage

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.

getUserMessage

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

getValues

@Nonnull

open override fun getValues(): MutableList<String>

isAcknowledged

open override fun isAcknowledged(): Boolean

isFromGuild

open fun isFromGuild(): 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 p0: String): ReplyCallbackAction

@Nonnull

@CheckReturnValue

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

replyComponents

@Nonnull

@CheckReturnValue

open fun replyComponents(@Nonnull p0: MutableCollection<out LayoutComponent>): ReplyCallbackAction

@Nonnull

@CheckReturnValue

open fun replyComponents(@Nonnull p0: LayoutComponent, @Nonnull vararg p1: LayoutComponent): ReplyCallbackAction

replyEmbeds

@Nonnull

@CheckReturnValue

open fun replyEmbeds(@Nonnull p0: MutableCollection<out MessageEmbed>): ReplyCallbackAction

@Nonnull

@CheckReturnValue

open fun replyEmbeds(@Nonnull p0: MessageEmbed, @Nonnull vararg p1: MessageEmbed): ReplyCallbackAction

replyFiles

@Nonnull

@CheckReturnValue

open fun replyFiles(@Nonnull vararg p0: FileUpload): ReplyCallbackAction

@Nonnull

@CheckReturnValue

open fun replyFiles(@Nonnull p0: MutableCollection<out FileUpload>): ReplyCallbackAction

replyFormat

@Nonnull

@CheckReturnValue

open fun replyFormat(@Nonnull p0: String, @Nonnull vararg p1: Any): ReplyCallbackAction

replyGuild

@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.

replyGuild

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

replyLocalized

@CheckReturnValue

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

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

@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.

replyLocalized

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

replyLocalizedEphemeral

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

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

replyModal

@Nonnull

open override fun replyModal(@Nonnull p0: Modal): ModalCallbackAction

replyPoll

@Nonnull

@CheckReturnValue

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

replyUser

@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.

replyUser

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

replyWithPremiumRequired

@Nonnull

open override fun replyWithPremiumRequired(): PremiumRequiredCallbackAction

toString

open override fun toString(): String