BotCommands/io.github.freya022.botcommands.api.commands.text/BaseCommandEvent

BaseCommandEvent

abstract class BaseCommandEvent : MessageReceivedEvent, CancellableRateLimit, LocalizableTextCommand(source)

Event for regex-based text commands.

Localization

You can send localized replies using the user, guild and also any [Locale], by using this event directly, see LocalizableTextCommand for more details and configuration.

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

In both cases, you can configure the locale, using TextCommandLocaleProvider.

Rate limit cancellation

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

Constructors

BaseCommandEvent

constructor(@NotNull api: @NotNull JDA, responseNumber: Long, @NotNull message: @NotNull Message)

Properties

inputUser

val MessageReceivedEvent.inputUser: InputUser

Gets the message's author as an InputUser.

message

val message: Message

Functions

cancelRateLimit

abstract fun cancelRateLimit()

Cancels the token consumption of the current rate limited interaction.

failureReporter

abstract fun failureReporter(message: String): Consumer<in Throwable>

Throwable consumer that, when triggered, sends an error message to the event's GuildMessageChannel and to the bot owner with the exception name and the simple exception description

getArgumentsStr

abstract fun getArgumentsStr(): String

Returns the full argument part of the message

getArgumentsStrList

abstract fun getArgumentsStrList(): List<String>

Returns the unresolved arguments of the command event

getAuthor

open fun getAuthor(): User

getAuthorBestName

abstract fun getAuthorBestName(): String

Returns the best author name possibleIf the User is not in the guild then returns his tag (Name#Discriminator)If the User is in the guild then returns his effective name

getChannel

open fun getChannel(): MessageChannelUnion

getChannelType

open fun getChannelType(): ChannelType

getContext

@NotNull

abstract fun getContext(): @NotNull BContext

getDefaultEmbed

@NotNull

abstract fun getDefaultEmbed(): @NotNull EmbedBuilder

Returns the default embed, equivalent to BContext.getDefaultEmbedSupplier().get()

getDefaultIconStream

@Nullable

abstract fun getDefaultIconStream(): @Nullable InputStream

Returns the default embed footer icon, equivalent to BContext.getDefaultFooterIconSupplier().get()

getDefaultMessages

abstract fun getDefaultMessages(): DefaultMessages

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

getGuild

open fun getGuild(): Guild

getGuildChannel

open fun getGuildChannel(): GuildMessageChannelUnion

getGuildMessage

abstract fun getGuildMessage(localizationPath: String, entries: Array<Localization.Entry>): String

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

getGuildMessage

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

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

getJDA

open fun getJDA(): JDA

getJumpUrl

open fun getJumpUrl(): String

getLocalizationBundle

abstract fun getLocalizationBundle(): String

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

getLocalizationContext

abstract fun getLocalizationContext(bundleName: String, pathPrefix: String): LocalizationContext

Returns a localization context for the provided bundle name and path prefix.

abstract fun getLocalizationContext(bundleName: String, pathPrefix: String): TextLocalizationContext

Returns a localization context for the provided bundle name and path prefix, using the locale from TextCommandLocaleProvider.getDiscordLocale.

getLocalizationPrefix

abstract fun getLocalizationPrefix(): 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.

getLocalizedMessage

abstract fun getLocalizedMessage(locale: Locale, localizationPath: String, entries: Array<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

@NotNull

open fun getMember(): @NotNull Member

The Author of the Message received as Member object.

getMessageId

open fun getMessageId(): String

getMessageIdLong

open fun getMessageIdLong(): Long

getRawData

open fun getRawData(): DataObject

getResponseNumber

open fun getResponseNumber(): Long

indicateError

@CheckReturnValue

@NotNull

abstract fun indicateError(@NotNull text: @NotNull CharSequence): @NotNull RestAction<Message>

@CheckReturnValue

@NotNull

abstract fun indicateError(@NotNull embed: @NotNull MessageEmbed, @NotNull other: Array<@NotNull MessageEmbed>): @NotNull RestAction<Message>

Sends an error reply in the event's channel

indicateErrorFormat

@CheckReturnValue

@NotNull

abstract fun indicateErrorFormat(@NotNull format: @NotNull String, @NotNull args: Array<@NotNull Any>): @NotNull RestAction<Message>

Sends an error reply in the event's channel

isFromGuild

open fun isFromGuild(): Boolean

isFromThread

open fun isFromThread(): Boolean

isFromType

open fun isFromType(type: ChannelType): Boolean

isRateLimitCancelled

abstract fun isRateLimitCancelled(): Boolean

isWebhookMessage

open fun isWebhookMessage(): Boolean

reactError

@CheckReturnValue

abstract fun reactError(): RestAction<Void>

Add a :x: reaction on the event message to indicate a command error

reactSuccess

@CheckReturnValue

abstract fun reactSuccess(): RestAction<Void>

Add a :white_check_mark: reaction on the event message to indicate command success

@CheckReturnValue

@NotNull

abstract fun reply(@NotNull text: @NotNull CharSequence): @NotNull MessageCreateAction

@CheckReturnValue

@NotNull

abstract fun reply(@NotNull embed: @NotNull MessageEmbed, @NotNull other: Array<@NotNull MessageEmbed>): @NotNull MessageCreateAction

Sends a reply in the event's channel

replyFile

@CheckReturnValue

@NotNull

abstract fun replyFile(@NotNull fileUploads: Array<@NotNull FileUpload>): @NotNull RestAction<Message>

Sends a file as a reply in the event's channel

replyFormat

@CheckReturnValue

@NotNull

abstract fun replyFormat(@NotNull format: @NotNull String, @NotNull args: Array<@NotNull Any>): @NotNull MessageCreateAction

Sends a reply in the event's channel

replyGuild

abstract fun replyGuild(localizationPath: String, entries: Array<Localization.Entry>): MessageCreateAction

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

replyGuild

fun LocalizableTextCommand.replyGuild(localizationPath: String, vararg entries: PairEntry): MessageCreateAction

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

replyLocalized

open fun replyLocalized(locale: DiscordLocale, localizationPath: String, entries: Array<Localization.Entry>): MessageCreateAction

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

replyLocalized

fun BaseCommandEvent.replyLocalized(context: LocalizationContext, localizationPath: String, vararg entries: PairEntry): MessageCreateAction

Replies a localized message to the user's command.

fun LocalizableTextCommand.replyLocalized(locale: Locale, localizationPath: String, vararg entries: PairEntry): MessageCreateAction

fun LocalizableTextCommand.replyLocalized(locale: DiscordLocale, localizationPath: String, vararg entries: PairEntry): MessageCreateAction

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

reportError

abstract fun reportError(message: String, e: Throwable)

Send an error message to the event's GuildMessageChannel and to the bot owner with the exception name and the simple exception description

respond

@CheckReturnValue

@NotNull

abstract fun respond(@NotNull text: @NotNull CharSequence): @NotNull MessageCreateAction

@CheckReturnValue

@NotNull

abstract fun respond(@NotNull embed: @NotNull MessageEmbed, @NotNull other: Array<@NotNull MessageEmbed>): @NotNull MessageCreateAction

Sends a response in the event's channel

respondFile

@CheckReturnValue

@NotNull

abstract fun respondFile(@NotNull fileUploads: Array<@NotNull FileUpload>): @NotNull MessageCreateAction

Sends a file as a response in the event's channel

respondFormat

@CheckReturnValue

@NotNull

abstract fun respondFormat(@NotNull format: @NotNull String, @NotNull args: Array<@NotNull Any>): @NotNull MessageCreateAction

Sends a response in the event's channel

respondGuild

abstract fun respondGuild(localizationPath: String, entries: Array<Localization.Entry>): MessageCreateAction

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

respondGuild

fun LocalizableTextCommand.respondGuild(localizationPath: String, vararg entries: PairEntry): MessageCreateAction

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

respondLocalized

open fun respondLocalized(locale: DiscordLocale, localizationPath: String, entries: Array<Localization.Entry>): MessageCreateAction

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

respondLocalized

fun BaseCommandEvent.respondLocalized(context: LocalizationContext, localizationPath: String, vararg entries: PairEntry): MessageCreateAction

Sends a localized message to the event's channel.

fun LocalizableTextCommand.respondLocalized(locale: Locale, localizationPath: String, vararg entries: PairEntry): MessageCreateAction

fun LocalizableTextCommand.respondLocalized(locale: DiscordLocale, localizationPath: String, vararg entries: PairEntry): MessageCreateAction

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

sendWithEmbedFooterIcon

@CheckReturnValue

abstract fun sendWithEmbedFooterIcon(embed: MessageEmbed): RestAction<Message>

Sends a MessageEmbed on the event's channel with the default footer icon

@CheckReturnValue

abstract fun sendWithEmbedFooterIcon(channel: MessageChannel, embed: MessageEmbed): RestAction<Message>

@CheckReturnValue

abstract fun sendWithEmbedFooterIcon(channel: MessageChannel, iconStream: InputStream, embed: MessageEmbed): RestAction<Message>

Sends a MessageEmbed on the specified channel with the default footer icon

setLocalizationBundle

abstract fun setLocalizationBundle(<set-?>: String)

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

setLocalizationPrefix

abstract fun setLocalizationPrefix(<set-?>: 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.

toString

open fun toString(): String