BotCommands/io.github.freya022.botcommands.api.commands.application.context.message/GlobalMessageEvent

GlobalMessageEvent

open class GlobalMessageEvent : MessageContextInteractionEvent, CancellableRateLimit, LocalizableInteraction, LocalizableReplyCallback(source)

Interaction event for global message context commands.

Localization

You can send localized replies 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 ApplicationCommandFilter, you can also return the bucket token with cancelRateLimit if you want to avoid consuming bandwidth in certain conditions.

See also

GuildMessageEvent

Inheritors

GuildMessageEvent

Properties

val context: BContext

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.

@Nonnull

open override fun deferReply(): ReplyCallbackAction

@Nonnull

@CheckReturnValue

open fun deferReply(p0: Boolean): ReplyCallbackAction

@Nullable

open override fun getChannel(): MessageChannelUnion?

@Nullable

open fun getChannelId(): String?

getChannelIdLong

open override fun getChannelIdLong(): Long

@Nonnull

open fun getChannelType(): ChannelType

@Nonnull

open fun getCommandId(): String

getCommandIdLong

open override fun getCommandIdLong(): Long

getCommandString

@Nonnull

open fun getCommandString(): String

@Nonnull

open override fun getCommandType(): Command.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>

getFullCommandName

@Nonnull

open fun getFullCommandName(): String

@Nullable

open override fun getGuild(): Guild?

getGuildChannel

@Nonnull

open fun getGuildChannel(): GuildChannel

@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

open override fun getHook(): LocalizableInteractionHook

@Nonnull

open fun getId(): String

open override fun getIdLong(): Long

@Nonnull

open override fun getInteraction(): MessageContextInteraction

@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

@Nullable

open override fun getMember(): Member?

getMessageChannel

@Nonnull

open fun getMessageChannel(): MessageChannel

@Nonnull

open override fun getName(): String

@Nullable

open fun getOption(@Nonnull p0: String): OptionMapping?

@Nullable

open fun <T : Any> getOption(@Nonnull p0: String, @Nonnull p1: Function<in OptionMapping, out T>): T?

open fun <T : Any> getOption(@Nonnull p0: String, @Nullable p1: T?, @Nonnull p2: Function<in OptionMapping, out T>): T

open fun <T : Any> getOption(@Nonnull p0: String, @Nullable p1: Supplier<out T>?, @Nonnull p2: Function<in OptionMapping, out T>): T

@Nonnull

open override fun getOptions(): MutableList<OptionMapping>

getOptionsByName

@Nonnull

open fun getOptionsByName(@Nonnull p0: String): MutableList<OptionMapping>

getOptionsByType

@Nonnull

open fun getOptionsByType(@Nonnull p0: OptionType): MutableList<OptionMapping>

open override fun getRawData(): DataObject?

getResponseNumber

open override fun getResponseNumber(): Long

getSubcommandGroup

@Nullable

open override fun getSubcommandGroup(): String?

getSubcommandName

@Nullable

open override fun getSubcommandName(): String?

@Nonnull

open override fun getTarget(): Message

@Nonnull

open override fun getTargetType(): ContextInteraction.ContextTarget

@Nonnull

open fun getTimeCreated(): OffsetDateTime

@Nonnull

open override fun getToken(): String

@Nonnull

open fun getType(): InteractionType

open override fun getTypeRaw(): Int

@Nonnull

open override fun getUser(): User

@Nonnull

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

open override fun isAcknowledged(): Boolean

open fun isFromGuild(): Boolean

isGlobalCommand

open fun isGlobalCommand(): Boolean

open override fun isGuildCommand(): Boolean

@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

@Nonnull

@CheckReturnValue

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

@Nonnull

@CheckReturnValue

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

@Nonnull

@CheckReturnValue

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

@Nonnull

@CheckReturnValue

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

@Nonnull

@CheckReturnValue

open fun replyFormat(@Nonnull p0: String, @Nonnull vararg p1: 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

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

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.

@Nonnull

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

@Nonnull

@CheckReturnValue

open fun replyPoll(@Nonnull p0: 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

replyWithPremiumRequired

@Nonnull

open override fun replyWithPremiumRequired(): PremiumRequiredCallbackAction

open override fun toString(): String